Docs

Setup docs

Manja starts from the spec file and source revision developers already maintain. Connect the source, choose the revision to publish, and keep the public docs pinned to a stable known-good version.

Run locally

The current vertical slice renders a read-only OpenAPI reference from a spec file and stores publication metadata in a local data directory.

Commandshell

go run ./cmd/manja \
  -spec internal/adapters/openapi/testdata/github-v3-rest.json \
  -data-dir .manja/data

Point at source

Keep the OpenAPI file in the repository that already owns it. Manja needs the repository, credentials when required, a spec path, and the revision or singleton file source to index.

Repository: Remote or local source that owns the spec.
Spec path: Path such as docs/openapi.yaml or api/openapi.yaml.
Revision: Branch, tag, commit, or file source used as the publication candidate.

Handle versions

Branches, tags, commits, and singleton spec files stay close to source control. Manja can index each candidate and expose the selected version without asking maintainers to author docs in a second place.

Publish deliberately

Public docs should show the chosen version until a later sync is healthy enough to replace it. That last-known-good behavior keeps readers on stable docs even if source access or parsing fails later.

Generated examples and request snippets are useful for readers, but the public surface remains read-only and does not proxy upstream APIs.