Link spec pages and anchor content to the model.
Good navigation ties specs together and anchors them to the model. Use relative links between pages, heading anchors within a page, and Cards for “read next” sections.
Linking between pages
Use relative links so they resolve within the section:
See [Embed Objects](embed-objects) for filtering.
Back to the [Specifications overview](../index).| Target | Pattern |
|---|---|
| Sibling page | embed-objects |
| Parent overview | ../index |
| Another section | ../../modeling/explore |
Prefer relative links
Relative links keep navigation correct across environments. Avoid hardcoded absolute URLs for internal pages.
Heading anchors
Headings generate anchors automatically. Link within or across pages:
Jump to [Filtering](#filtering).
See [Embed Objects](embed-objects#filtering).Read-next with Cards
<Cards>
<Card title="Embed Workflow" href="embed-workflow">
Show a workflow sequence diagram.
</Card>
<Card title="Embed Attachments" href="embed-attachments">
Embed an ERD or OpenAPI contract.
</Card>
</Cards>Card hrefs are relative
Card links use relative paths, just like Markdown links. Keep them relative
to the current page’s location.
Anchoring to the model
Link to objects
Embed an objects diagram or link to the relevant model area.
Embed contracts
Use attachments so specs reference live ERDs and OpenAPI.
Connect related specs
Add a Cards block pointing to the next logical pages.
End substantial pages with a short “read next” Cards block. It guides readers and reduces dead ends.
Last updated on