omnara/docs at main · omnara-ai/omnara · GitHub
Skip to content

Latest commit

 

History

History

docs

README.md

Omnara Documentation

Mintlify documentation published to docs.omnara.com.

Development

npx mintlify dev

Changelog

Write product updates in changelog.mdx, with the newest entry first. Use one <Update> per entry and link to relevant docs for details. Entries are maintained manually. The root CHANGELOG.md links to the published page instead of repeating its content.

API reference

The endpoint pages are generated by Mintlify at build time from the published copy of the spec. The API Reference group in docs.json sets openapi to api-reference/openapi.yaml, so Mintlify creates one page per operation, grouped by OpenAPI tag, alongside the hand-written overview page — there is no hand-maintained endpoint list.

After any change to the canonical spec (api/openapi/openapi.yaml), refresh the published copy:

make docs-openapi

The spec declares the hosted https://api.omnara.com/v1 server, which enables the Mintlify playground.

Operations tagged with x-hidden: true in the spec (the machine-daemon transport routes) are excluded from the generated nav — they're the internal daemon protocol, not public API surface — but remain in the downloadable spec.