Skip to content

Commit 6f4da2e

Browse files
committed
Update README with linking rules
1 parent 2da0af4 commit 6f4da2e

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,16 @@ Content can be authored in Markdown, in a `.md` or `.mdx` file. The Starlight do
3939
* [Authoring Content in Markdown](https://starlight.astro.build/guides/authoring-content/)
4040
* [Using Components](https://starlight.astro.build/components/using-components/) (only in `.mdx`)
4141

42+
### Linking Rules
43+
44+
* Always prefer linking internally over linking externally. For example, when you talk about data protection, prefer an internal link over a link to external sites.
45+
* When linking to external content, consider writing one or two sentences about the context and what the reader will learn on the linked page.
46+
* When linking other pages, use a path that starts at the content root, like `/identityserver/troubleshooting.md`. Use the `.md(x)` file extension - Starlight will update the link to the correct format on build.
47+
* When linking to external resources, use the full URL using HTTPS.
48+
* You can link to header anchors using the `#` symbol, for example `[multiple authentication methods](/identityserver/ui/federation.md#multiple-authentication-methods-for-users)`.
49+
* Link relevant text. Prefer `learn more about [improving the sign-in experience]` over `click [here] to learn more`.
50+
* Run `npm run linkchecker` to validate all links (note this will ignore links to GitHub because of rate limits in place).
51+
4252
## 🧞 Commands
4353

4454
All commands are run from the root of the project, from a terminal:

0 commit comments

Comments
 (0)