Skip to content

feat(docs): snippet highlights, mirrored guide groups, and Guides group order - #153

Merged
NathanFlurry merged 1 commit into
mainfrom
docs/agents-guides
Oct 24, 2026
Merged

NathanFlurry merged 1 commit into
mainfrom
docs/agents-guides

Conversation

@NathanFlurry

Copy link
Copy Markdown
Member

Summary

  • <CodeSnippet highlight="region">: shows the whole file and dims every line outside the named // docs:start / // docs:end regions (several with highlight="a,b", combinable with region). An unknown region fails the build like a bad region. Highlighted blocks skip the "Show more" collapse so the highlight is never hidden.
  • Mirrored guides in a docs sidebar: a docs group with "mirror": "guides" gets the bundle's own guides as its pages, so the Agents tab can list them without repeating the list. Links open on the Guides tab.
  • Guides tab order: General, Architecture, Agents, Guides.
  • ExampleLinkBar: always reads "See the full example on GitHub." and no longer takes a label.

Needed before the next rivet-dev/agents docs sync (rivet-dev/agents#364), which uses highlight and mirror.

Testing

Locally with vendored docs only: pnpm assemble, pnpm check:sitemap, pnpm build, pnpm check:seo. Previewed with the agents docs that use both features.

🤖 Generated with Claude Code

… group order

- `<CodeSnippet highlight="region">` shows the whole file and dims every line
  outside the named `docs:start`/`docs:end` regions. Highlighted blocks skip
  the "Show more" collapse so the highlight is never hidden.
- A docs sidebar group with `"mirror": "guides"` lists the bundle's own guides,
  so a docs tab can link them without repeating the list.
- The Guides tab orders groups Architecture, Agents, then Guides.
- `ExampleLinkBar` always reads "See the full example on GitHub." and no
  longer takes a label.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@railway-app
railway-app Bot temporarily deployed to rivet-website / website-pr-153 October 24, 2026 02:01 Destroyed
@NathanFlurry
NathanFlurry merged commit 98e8692 into main Oct 24, 2026
3 of 4 checks passed
@NathanFlurry
NathanFlurry deleted the docs/agents-guides branch October 24, 2026 02:36

This branch was successfully deployed

No deployments
rivet-website / website-pr-153 — c3c19471 Deployed Oct 24, 2026 by railway-app[bot]
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.

1 participant