Skip to content

docs: link the registry onboarding guide from the site navigation and docs/README.md - #498

Merged
eagmon merged 2 commits into
mainfrom
docs/registry-onboarding-links
Nov 9, 2026
Merged

eagmon merged 2 commits into
mainfrom
docs/registry-onboarding-links

Conversation

@AlexPatrie

Copy link
Copy Markdown
Contributor

Follow-up to #493, item 2 of the review: nothing linked to docs/registry-onboarding.md.

What changes

  • mkdocs.yml: one navigation line, "Adding a simulator", after "Modules". The page is not in exclude_docs, so it is already built into the published site; it was reachable only by URL.
  • docs/README.md: registry-onboarding.md added to the sentence that lists the pages the site carries, and one row added to the document table (user documentation).

Not changed

Checked

  • mkdocs build -s (what make docs-test runs) succeeds on this tree in a linux/amd64 container; the built site's index links to the page.
  • All pre-commit hooks of the repository pass on a clean copy of this tree (case/merge conflicts, toml, yaml, json, pretty-format-json, end-of-file-fixer, trailing-whitespace, ruff check, ruff format).

🤖 Generated with Claude Code

… docs/README.md

docs/registry-onboarding.md is built into the published site (it is not in
exclude_docs) but nothing linked to it. Add it to the mkdocs navigation and to
the list of site pages and the document table in docs/README.md.

Co-Authored-By: Claude Sonnet 5.5 <noreply@anthropic.com>
@AlexPatrie
AlexPatrie requested a review from jcschaff November 2, 2026 23:17
@eagmon
eagmon marked this pull request as ready for review November 9, 2026 23:01

@eagmon eagmon left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Docs-only: adds the registry-onboarding guide to the site nav and the docs/README index. Target file exists, check-docs green. LGTM.

@eagmon
eagmon merged commit f7a435d into main Nov 9, 2026
9 checks passed
@eagmon
eagmon deleted the docs/registry-onboarding-links branch November 9, 2026 23:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants