Links

Links should help readers move through a workflow. Use descriptive link text instead of generic labels.

Internal links#

Use internal links to connect related tasks without forcing readers back to the sidebar.

Read [Create your first page](/docs/getting-started/first-page) before adding nested sections.

Link text#

The link text should name the destination. Avoid labels like click here or read more.

Link checklist#

Use this checklist when adding or renaming docs pages.

• Link to the next step at the end of setup pages.
• Link related reference pages from guides.
• Avoid repeating the same link in every paragraph.
• Use external links only when the reader must leave the template.

Broken link review#

When renaming files or folders, review all internal links that point to the old slug.

Linking patterns#

Use links to create a path through related pages. A reader should understand why the destination matters before they click it.

Next-step links#

Put next-step links near the end of a guide when the current page is part of a sequence. This keeps readers moving without forcing them to use the sidebar.

Reference links#

Use reference links when a concept needs detail but should not interrupt the current workflow. Keep the current page focused on the task.

External links#

External links should be rare in product docs. They are useful for source material, specifications, and tools that readers must open to finish the work.

Exit context#

When linking away from the site, explain what the reader will find there. This prevents external links from feeling like unexplained detours.