mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-05-12 12:54:07 -07:00
docs(links): update docs-writer skill and fix broken link (#21314)
This commit is contained in:
@@ -118,6 +118,8 @@ documentation.
|
|||||||
reflects existing code.
|
reflects existing code.
|
||||||
- **Structure:** Apply "Structure (New Docs)" rules (BLUF, headings, etc.) when
|
- **Structure:** Apply "Structure (New Docs)" rules (BLUF, headings, etc.) when
|
||||||
adding new sections to existing pages.
|
adding new sections to existing pages.
|
||||||
|
- **Headers**: If you change a header, you must check for links that lead to
|
||||||
|
that header and update them.
|
||||||
- **Tone:** Ensure the tone is active and engaging. Use "you" and contractions.
|
- **Tone:** Ensure the tone is active and engaging. Use "you" and contractions.
|
||||||
- **Clarity:** Correct awkward wording, spelling, and grammar. Rephrase
|
- **Clarity:** Correct awkward wording, spelling, and grammar. Rephrase
|
||||||
sentences to make them easier for users to understand.
|
sentences to make them easier for users to understand.
|
||||||
@@ -133,7 +135,8 @@ and that all links are functional.
|
|||||||
technical behavior.
|
technical behavior.
|
||||||
2. **Self-review:** Re-read changes for formatting, correctness, and flow.
|
2. **Self-review:** Re-read changes for formatting, correctness, and flow.
|
||||||
3. **Link check:** Verify all new and existing links leading to or from modified
|
3. **Link check:** Verify all new and existing links leading to or from modified
|
||||||
pages.
|
pages. If you changed a header, ensure that any links that lead to it are
|
||||||
|
updated.
|
||||||
4. **Format:** Once all changes are complete, ask to execute `npm run format`
|
4. **Format:** Once all changes are complete, ask to execute `npm run format`
|
||||||
to ensure consistent formatting across the project. If the user confirms,
|
to ensure consistent formatting across the project. If the user confirms,
|
||||||
execute the command.
|
execute the command.
|
||||||
|
|||||||
@@ -369,7 +369,7 @@ those files are not automatically deleted and must be managed manually.
|
|||||||
[model routing]: /docs/cli/telemetry.md#model-routing
|
[model routing]: /docs/cli/telemetry.md#model-routing
|
||||||
[preferred external editor]: /docs/reference/configuration.md#general
|
[preferred external editor]: /docs/reference/configuration.md#general
|
||||||
[session retention]: /docs/cli/session-management.md#session-retention
|
[session retention]: /docs/cli/session-management.md#session-retention
|
||||||
[extensions]: /docs/extensions/index.md
|
[extensions]: /docs/extensions/
|
||||||
[Conductor]: https://github.com/gemini-cli-extensions/conductor
|
[Conductor]: https://github.com/gemini-cli-extensions/conductor
|
||||||
[open an issue]: https://github.com/google-gemini/gemini-cli/issues
|
[open an issue]: https://github.com/google-gemini/gemini-cli/issues
|
||||||
[Agent Skills]: /docs/cli/skills.md
|
[Agent Skills]: /docs/cli/skills.md
|
||||||
|
|||||||
Reference in New Issue
Block a user