This repository contains the documentation for Namespace, a platform for ENS subname management and development tools.
The repository uses Node.js 22 and a pinned version of the Mintlify CLI. If you use nvm, select the correct Node.js version before installing dependencies:
nvm use
npm ci
npm run devOpen the local URL printed by Mintlify. Changes to MDX files and docs.json reload automatically.
Run the complete documentation test suite:
npm run checkThe suite validates the Mintlify build, checks links and accessibility, enforces repository content conventions, and type-checks the SDK examples.
Read CONTRIBUTING.md before adding or moving pages. Writing and terminology conventions live in STYLE_GUIDE.md, and new guides should start from the documentation page template.
The Mintlify GitHub App deploys changes from the default branch. Before merging a documentation change:
- Preview it locally.
- Run
npm run check. - Confirm new pages appear in
docs.jsonnavigation. - Add redirects for moved or retired routes.
- Review screenshots, alternative text, and external links.