-
Notifications
You must be signed in to change notification settings - Fork 3
docs(projects): add Projects docs and restore docs.json trailing newline #1279
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
base: master
Are you sure you want to change the base?
docs(projects): add Projects docs and restore docs.json trailing newline #1279
Conversation
Summary of ChangesHello @dittops, 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 significantly expands the product's documentation by adding a complete suite of guides and reference materials for the new Projects module. The new content aims to provide users with a thorough understanding of project creation, management, and operational aspects, enhancing the overall user experience and clarity. Concurrently, it ensures the documentation structure is properly reflected in the site's navigation and maintains code quality by addressing a minor formatting issue. 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. Changelog
Activity
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 a comprehensive set of documentation for the new Projects module. The documentation is well-structured, clear, and provides a good overview for users. The update to docs.json correctly integrates the new pages into the site navigation.
However, I have a significant concern about the duplication of all new documentation files under the master/docs/projects/ directory. This approach will create a maintenance challenge, making it difficult to keep documentation consistent over time. I've left a specific comment with suggestions on how to handle this without committing duplicated files. Addressing this will greatly improve the long-term maintainability of the documentation.
Motivation
docs/docs.jsonand verifying no trailing spaces were reintroduced.Description
docs/docs.jsonto add a Projects section and include the new pages in the navigation.docs/projects/(introduction.mdx,quickstart.mdx,project-concepts.mdx,creating-first-project.mdx,guides/deployment-settings-and-autoscaling.mdx,guides/managing-project-members.mdx,reference/project-tabs-reference.mdx, andtroubleshooting.mdx).master/docs/projects/for the master path to keep repository mirrors consistent.docs/docs.jsonand verified formatting-sensitive changes (no trailing spaces inintroduction.mdx) were not regressed.Testing
rg -n "\s+$" docs/projects/introduction.mdx master/docs/projects/introduction.mdx docs/docs.json || trueto confirm no trailing spaces, which returned clean results.from pathlib import Path; Path('docs/docs.json').read_bytes().endswith(b'\n')to confirmdocs/docs.jsonends with a newline, which returnedTrue.git status --shortand committed the newline fix using the messagefix(docs): restore docs.json trailing newline for pre-commit, which succeeded.Codex Task