The source for the Weaverse documentation site — guides, API reference, and theme documentation for building Shopify Hydrogen storefronts with Weaverse.
Built with Mintlify. Content is written in MDX;
navigation and site configuration live in docs.json.
| Path | Contents |
|---|---|
docs.json |
Mintlify configuration: navigation, theme, redirects |
index.mdx |
Homepage |
intro/, getting-started/ |
Introduction and setup guides |
development-guide/ |
Component development guides |
api-reference/ |
Hooks, components, utilities, and types |
developer-tools/ |
CLI, SDKs, and MCP server documentation |
content-api/, features/, guides/ |
Feature and integration guides |
hydrogen-themes/, migration-advanced/ |
Theme and migration documentation |
resources/, community/, changelog/ |
FAQ, tutorial, community, release notes |
Requires Node.js 24 (the version Mintlify's CLI is currently tested against).
Install the Mintlify CLI:
npm i -g mintPreview the site locally — run from the repository root, where docs.json lives:
mint devThe preview is served at http://localhost:3000. MDX edits hot-reload; changes
to docs.json require restarting mint dev.
mint dev validates docs.json on startup and reports MDX and configuration
errors in the terminal. Check for broken links before opening a pull request:
mint broken-linksKeep the CLI current if the local preview misbehaves:
mint updateAdding a page takes two steps — a file without a navigation entry returns a 404, and a navigation entry without a file fails the build.
- Create the
.mdxfile in the appropriate directory withtitleanddescriptionfrontmatter. - Add its path to the
navigationarray indocs.json, without the.mdxextension (resources/faq, notresources/faq.mdx).
Then restart mint dev and confirm the page renders and appears in the sidebar.
- Branch off
main. - Make your changes and preview them with
mint dev. - Verify internal links resolve to pages that exist in
docs.json. - Open a pull request describing what changed and why.
Documentation must match current SDK behaviour — verify code examples against
the version of @weaverse/hydrogen you are documenting rather than copying older
snippets. See CLAUDE.md for the full content conventions used in this repo.
The Mintlify GitHub app deploys this repository automatically: merging to main
publishes the updated documentation to production.