Fix all doc prefixes#79
Conversation
There was a problem hiding this comment.
Summary of Changes
Hello @abatilo, 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 primarily focuses on improving the user experience of the documentation site by fixing broken internal links and providing clear placeholders for sections that are not yet fully developed. The changes ensure that navigation within the documentation is accurate and prevents users from encountering unexpected 404 pages.
Highlights
- Documentation Link Fixes: I've updated numerous internal documentation links across various sections (administration, concepts, developer guide, tasks) to correctly include the
/omepath prefix. This resolves 404 errors that occurred because the documentation site is served with this prefix, not from the root. - Placeholder Documentation Pages: I've created many new
.mdfiles across the documentation structure, serving as placeholders for future content. These pages now display 'Coming soon!' instead of resulting in 404 errors when users navigate to non-existent sections. - Dependency Update: The
github.com/google/docsydependency has been updated from versionv0.10.0tov0.11.0ingo.sum, likely to support the documentation site's structure and rendering.
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 in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands.
| 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 issue 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 is currently in preview and 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 to provide feedback.
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
-
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. ↩
There was a problem hiding this comment.
Code Review
This pull request fixes incorrect path prefixes in the documentation and adds placeholder pages for documentation that doesn't yet exist. The path prefixes are updated to include /ome, and placeholder Coming soon! pages are added to prevent 404 errors.
Currently, there are a lot of 404s in the docs because of incorrect path prefixes. Most of the links assume that the docs are served at the root of the docs site, but actually there's an `/ome` prefix. Also, in places where docs don't actually exist, I've created a place holder `Coming soon!` instead of users confusingly getting a 404.
7f03d27 to
a2b7dc2
Compare
|
much appreciated!!!!!! |
Currently, there are a lot of 404s in the docs because of incorrect path prefixes. Most of the links assume that the docs are served at the root of the docs site, but actually there's an `/ome` prefix. Also, in places where docs don't actually exist, I've created a place holder `Coming soon!` instead of users confusingly getting a 404.
Currently, there are a lot of 404s in the docs because of incorrect path
prefixes. Most of the links assume that the docs are served at the root
of the docs site, but actually there's an
/omeprefix.Also, in places where docs don't actually exist, I've created a place
holder
Coming soon!instead of users confusingly getting a 404.