mirror of
https://github.com/google-gemini/gemini-cli.git
synced 2026-04-26 13:04:49 -07:00
Docs: Update docs skill for links
This commit is contained in:
@@ -65,13 +65,20 @@ accessible.
|
|||||||
- **UI and code:** Use **bold** for UI elements and `code font` for filenames,
|
- **UI and code:** Use **bold** for UI elements and `code font` for filenames,
|
||||||
snippets, commands, and API elements. Focus on the task when discussing
|
snippets, commands, and API elements. Focus on the task when discussing
|
||||||
interaction.
|
interaction.
|
||||||
- **Links:** Use descriptive anchor text; avoid "click here." Ensure the link
|
|
||||||
makes sense out of context.
|
|
||||||
- **Accessibility:** Use semantic HTML elements correctly (headings, lists,
|
- **Accessibility:** Use semantic HTML elements correctly (headings, lists,
|
||||||
tables).
|
tables).
|
||||||
- **Media:** Use lowercase hyphenated filenames. Provide descriptive alt text
|
- **Media:** Use lowercase hyphenated filenames. Provide descriptive alt text
|
||||||
for all images.
|
for all images.
|
||||||
|
|
||||||
|
### Links
|
||||||
|
- **Accessibility:** Use descriptive anchor text; avoid "click here."Ensure the
|
||||||
|
link makes sense out of context, such as when being read by a screen reader.
|
||||||
|
- **Use relative links in docs:** Use relative links in documentation to
|
||||||
|
ensure portability; avoid absolute URLs for links within the same repository. Do not
|
||||||
|
include the /docs/ section of a link.
|
||||||
|
- **When changing headings, check for deep links:** If a user is changing a heading,
|
||||||
|
check for deep links to that heading in other pages, and update accordingly.
|
||||||
|
|
||||||
### Structure
|
### Structure
|
||||||
- **BLUF:** Start with an introduction explaining what to expect.
|
- **BLUF:** Start with an introduction explaining what to expect.
|
||||||
- **Experimental features:** If a feature is clearly noted as experimental,
|
- **Experimental features:** If a feature is clearly noted as experimental,
|
||||||
@@ -126,7 +133,6 @@ documentation.
|
|||||||
- **Consistency:** Check for consistent terminology and style across all edited
|
- **Consistency:** Check for consistent terminology and style across all edited
|
||||||
documents.
|
documents.
|
||||||
|
|
||||||
|
|
||||||
## Phase 4: Verification and finalization
|
## Phase 4: Verification and finalization
|
||||||
Perform a final quality check to ensure that all changes are correctly formatted
|
Perform a final quality check to ensure that all changes are correctly formatted
|
||||||
and that all links are functional.
|
and that all links are functional.
|
||||||
|
|||||||
Reference in New Issue
Block a user