Docs: 'docs-writer' skill for relative links.

This commit is contained in:
Jenna Inouye
2026-03-24 10:18:51 -07:00
parent 98df2307c4
commit f9e58c0f62
+5 -4
View File
@@ -73,10 +73,11 @@ accessible.
### Links ### Links
- **Accessibility:** Use descriptive anchor text; avoid "click here." Ensure the - **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. 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 - **Use relative links in docs:** Use relative links in documentation (`/docs/`)
portability. Use paths relative to the current file's directory (for example, to ensure portability. Use paths relative to the current file's directory
`../tools/` from `docs/cli/`). Do not include the `/docs/` section of a path, (for example, `../tools/` from `docs/cli/`). Do not include the `/docs/`
but do verify that the resulting relative link exists. section of a path, but do verify that the resulting relative link exists. This
does not apply to meta files such as README.MD and CONTRIBUTING.MD.
- **When changing headings, check for deep links:** If a user is changing a - **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 heading, check for deep links to that heading in other pages and update
accordingly. accordingly.