Skip to content

fix(docs): add docs.metadata.json for product neutral guides#15960

Open
bshaffer wants to merge 3 commits intomainfrom
ensure-product-neutral-guides-deploy
Open

fix(docs): add docs.metadata.json for product neutral guides#15960
bshaffer wants to merge 3 commits intomainfrom
ensure-product-neutral-guides-deploy

Conversation

@bshaffer
Copy link
Contributor

@bshaffer bshaffer commented Feb 17, 2026

This change is Reviewable

@bshaffer bshaffer requested a review from a team as a code owner February 17, 2026 20:27
@gemini-code-assist
Copy link

Summary of Changes

Hello @bshaffer, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

This pull request enhances the documentation build and publishing pipeline by integrating product-neutral guides. It ensures that these guides are properly processed, have their necessary metadata generated, and are included in the final documentation output, streamlining the overall documentation workflow.

Highlights

  • Documentation Build Process: Modified the documentation publishing script to include product-neutral guides in the build and upload process.
  • Metadata Generation: Implemented a CMake command to generate a docs.metadata.json file for product-neutral guides, providing essential metadata like language, name, and version.
Changelog
  • ci/cloudbuild/builds/publish-docs.sh
    • Updated the stage_docfx function to recognize and correctly path the guides feature for documentation.
    • Included guides in the list of features to be uploaded, enabling their publication.
  • docfx/product-neutral-guides/CMakeLists.txt
    • Added a custom CMake command to generate a docs.metadata.json file, containing language, name, and version information for the product-neutral guides.
    • Ensured the newly generated metadata file is included in the build process.
Activity
  • No human activity detected on this pull request.
Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature Command Description
Code Review /gemini review Performs a code review for the current pull request in its current state.
Pull Request Summary /gemini summary Provides a summary of the current pull request in its current state.
Comment @gemini-code-assist Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help /gemini help Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

  1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution.

Copy link

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request adds the necessary infrastructure to generate and publish documentation for product-neutral guides. The changes correctly modify the publishing script to handle the new 'guides' documentation type and add a docs.metadata.json file required by the publishing process. My review includes one suggestion to improve the maintainability of the CMake script by using configure_file instead of an embedded string with add_custom_command, which is a more idiomatic approach for file generation from a template.

@codecov
Copy link

codecov bot commented Feb 17, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 92.95%. Comparing base (6a4b2fb) to head (b557b42).

Additional details and impacted files
@@            Coverage Diff             @@
##             main   #15960      +/-   ##
==========================================
- Coverage   92.95%   92.95%   -0.01%     
==========================================
  Files        2460     2460              
  Lines      228901   228901              
==========================================
- Hits       212785   212779       -6     
- Misses      16116    16122       +6     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants