Customer-facing documentation for Hermai, hosted at docs.hermai.ai. Built on Mintlify.
Hermai is a community-driven schema registry for website APIs. Developers contribute schemas for site workflows. Callers use those schemas to get structured JSON without rediscovering the same site.
.
├── docs.json Mintlify config (nav, theme, colours, logo, navbar)
├── index.mdx Landing page
├── quickstart.mdx Sign up, create an API key, run a fetch, contribute
├── concepts/
│ ├── how-hermai-works.mdx Mental model: CLI discovery, registry lookup, hosted fetch
│ ├── hosted-fetch.mdx Hosted execution API
│ ├── schemas.mdx Schema format, contribution paths, validation, verified badge
│ ├── catalog.mdx Lookup API, intent requirement, rate limits, browsing
│ ├── actions.mdx Action types (api_call, navigate, search, paginate, submit_form)
│ ├── credits-and-usage.mdx Rate limits, credit earning
│ └── api-keys.mdx Auth, rate-limit tiers, schema access toggle
├── logo/ Brand marks
├── favicon.svg
├── images/ Static images used in docs pages
├── CONTRIBUTING.md How to edit pages, writing guidelines
└── AGENTS.md Style guide for AI-assisted doc writing
Requires the Mintlify CLI:
npm i -g mint
mint devPreview at http://localhost:3000. Changes on the default branch deploy to production automatically via the Mintlify GitHub app.
If the dev environment breaks, run mint update to pull the latest CLI.
See CONTRIBUTING.md for editing guidelines and local development setup.
- hermai.ai: Homepage
- docs.hermai.ai: Live docs
- hermai-cli: Open-source discovery CLI (AGPL-3.0)