Skip to content

docs(site): rebuild the docs and examples on the v2 canvas - #34

Merged
hyamero merged 4 commits into
mainfrom
docs/site-docs
Oct 1, 2026
Merged

hyamero merged 4 commits into
mainfrom
docs/site-docs

Conversation

@hyamero

@hyamero hyamero commented Oct 1, 2026

Copy link
Copy Markdown
Member

Rebuilds the docs and examples pages to follow the v2 design canvas.

Docs

  • New shell: a sidebar whose current page expands into its sections and tracks the one in view, a sticky bar and sheet on phones, previous/next links, and a compact footer.
  • ⌘K (or /) search over pages, sections, schema fields, CLI commands and options, viewer keys, diagnostic codes and examples. The index is built at build time and served as /search.json.
  • Quick start: the JSON sits beside the diagram, and pointing at either highlights the other.
  • New pages: the viewer (the real viewer, with feature buttons and the link each state makes), the CLI (validate, deliver, serve, options, diagnostics by family, every code, exit codes), and brand slugs (filterable, click to copy).
  • Schema reference rebuilt as field lists beside sticky samples, with the viewer's own sample card.
  • Kind pages moved to /docs/<kind>, with the skill's example, parts, rules, type tables, an "ask for one" request and examples. /kinds/<kind> redirects permanently.

Examples

  • /examples is a card grid with a kind filter and an agent toggle; ?kind= links straight to one kind.
  • A page per example at /examples/<key>: the viewer at full width, what the agent was asked (or what the kind is for), the JSON, and more examples of the same kind.

Kept true to the code

  • CLI terminal samples are real validate runs, generated at build time.
  • The diagnostic code list is read from the schema rules.
  • Schema samples are validated against the schema in a test.
  • Keys, export formats and kind rules were checked against the viewer, the CLI and the authoring contract.

Cleanup: the old gallery viewer, the "On this page" table of contents and CodeBlock are removed. EmbeddedViewer now has a single frame.

Tests: unit tests added for search ranking, JSON line ownership, docs navigation, diagnostic codes and schema samples. The e2e smoke suite now covers every new route, search, the sidebar, the gallery filters, the example pages and the redirect.

…debar with search, pages for the viewer, CLI, brands and each kind, and a page per example
@vercel

vercel Bot commented Oct 1, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
stackmap-site Ready Ready Preview Oct 1, 2026 7:14am UTC

@hyamero
hyamero merged commit d1a7ff3 into main Oct 1, 2026
7 checks passed
@hyamero
hyamero deleted the docs/site-docs branch October 1, 2026 17:11
@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.1.0-rc.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions

github-actions Bot commented Oct 2, 2026

Copy link
Copy Markdown
Contributor

🎉 This PR is included in version 0.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

This branch was successfully deployed

1 active deployment
Preview — 9e3b9a1e Deployed Oct 1, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant