From e721dc65b92f0bcfbd5309da007fa4e6a11d24b4 Mon Sep 17 00:00:00 2001 From: Jenna Inouye Date: Fri, 6 Mar 2026 13:36:41 -0800 Subject: [PATCH] Docs: Update docs skill for links --- .gemini/skills/docs-writer/SKILL.md | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/.gemini/skills/docs-writer/SKILL.md b/.gemini/skills/docs-writer/SKILL.md index d7cf7b81be..e30c95880c 100644 --- a/.gemini/skills/docs-writer/SKILL.md +++ b/.gemini/skills/docs-writer/SKILL.md @@ -65,13 +65,20 @@ accessible. - **UI and code:** Use **bold** for UI elements and `code font` for filenames, snippets, commands, and API elements. Focus on the task when discussing 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, tables). - **Media:** Use lowercase hyphenated filenames. Provide descriptive alt text 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 - **BLUF:** Start with an introduction explaining what to expect. - **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 documents. - ## Phase 4: Verification and finalization Perform a final quality check to ensure that all changes are correctly formatted and that all links are functional.