-
Notifications
You must be signed in to change notification settings - Fork 440
feat: product neutral guides #15865
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
feat: product neutral guides #15865
Conversation
Summary of ChangesHello @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 establishes the foundational framework for incorporating product-neutral documentation guides into the existing DocFX build system. It introduces a new CMake module to handle the copying and structuring of these generic guides, beginning with the project's Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe 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
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 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
|
There was a problem hiding this 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 introduces the build infrastructure for product-neutral guides. It adds a new CMake sub-project to copy guide files and generate a table of contents for docfx. The changes in GoogleCloudCppDoxygen.cmake to allow custom file patterns are well-implemented.
My review focuses on the new docfx/product-neutral-guides/CMakeLists.txt file. I've identified a potential issue with YAML generation if display names contain special characters, and a more significant build-ordering problem where the table of contents is generated at configure-time while the files it references are generated at build-time. Addressing these will make the new build logic more robust.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #15865 +/- ##
==========================================
- Coverage 92.96% 92.95% -0.01%
==========================================
Files 2460 2460
Lines 228931 228931
==========================================
- Hits 212826 212811 -15
- Misses 16105 16120 +15 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@scotthart The kokoro job for macosx cmake-vcpkg seems to be failing with the error "module 'OpenSSL.crypto' has no attribute 'sign'": I'm unsure however, as I do not think anything I did would cause this. Let me know if you have any thoughts on how I can resolve it! |
It's a known issue, unrelated to this PR. |
Submitting the DRAFT PR for early feedback
docs/, and add them toguide_source_filesREADME.mdso it does not contain broken links on devsite.[code-cpp[](FILENAME#SAMPLE)]