Compendium

No. 00Athena referencev4.2.0 · 9 min ago

A reference surface that keeps the reader oriented.

Athena is the canonical docs framework for teams who read to ship — a baseline-gridded reading surface with instant search, scroll-spy wayfinding, and a colour-true code pane. Dense where it counts, calm everywhere else.

Version
4.2.0
API coverage
98%
Median search
38ms
Reading state
0% read
athena.config.tsx
01import Compendium from './Compendium';02 03export default function DocsPage() {04  return (05    <Compendium06      version='4.2.0'07    />08  );09}
Cursor locks to commands within 160px4.2.0

No. 01Setup

Drop-in documentation shell.

One command scaffolds the reference layout, the scroll-spy rail, the colour-true code pane, and the search index into your app. No theme config, no MDX rewrite — Athena reads your existing routes.

  • Framework-agnostic shell — React, Vue, or plain HTML output.
  • Search index builds at postinstall; median query 38ms.
  • Ships typed props — your editor autocompletes every section id.

Requiresnode ≥ 18.17react ≥ 18

QuickstartGet started in 5 min
npx @kintura/cli add compendium --stack=react
  1. Run the add commandScaffolds the shell + writes a typed config. ~40s.
  2. Point at your content — contentDir: './docs'Athena indexes the tree and lifts the headings.
  3. npm run dev — ship to prod when greenScroll-spy, search, and progress wire automatically.
Skip setup — try Cloud.Hosted docs, instant search, and read analytics with zero config. Free for solo projects.

No. 02Reference

API routes with enough context to act.

Every endpoint is keyset-paginated, returns RFC 9457 problem details on error, and is rate-limited per token. Latencies are p50, measured us-east over the trailing 24h.

GET/v1/guides

Returns the active guide tree with anchors, order, and freshness metadata. Cursor-paginated, 100 per page.scope guides:read

41ms
POST/v1/examples/run

Executes a sandboxed snippet and streams structured diagnostics. 30s wall-clock ceiling.scope examples:run

212ms
PATCH/v1/sections/:id

Updates a documentation section while preserving canonical heading ids. Partial bodies allowed.scope sections:write

63ms
GET/v1/search

Full-text search across the indexed corpus. Returns ranked hits with highlighted spans.scope guides:read

38ms
DELETE/v1/sections/:id

Soft-deletes a section and queues its anchors for redirect. Reversible for 30 days.scope sections:write

57ms
5 of 140 endpoints · base https://api.athena.devFull OpenAPI spec →

No. 03Release health

Status cards that behave like reference data.

All systems nominalSynced 41s ago
Docs Version
4.2.0

Athena reference channel · 9 min ago

Shipped 4.2.0 — 38 commits since 4.1
API Coverage
98%

137 of 140 endpoints indexed

+4 endpoints this week · 3 pending
Build Status
Stable

421 checks green · 0 failing

Uptime 99.98% / 30d · 0 incidents

No. 05Doc feedback

Was this page useful?

Helpful?

Edit on GitHub

Last updated a3f0e91

No. 04Ready state

You have the context. Ship the docs.

Wired in roughly 5 minutes — one component, zero runtime config, search and scroll-spy on by default. From here it is your prose and our wayfinding.

npx @kintura/cli add compendium --stack=react