Skip to main content

Reference

This section will hold auto-generated reference material for Helm:

  • API endpoints — every HTTP route, with request/response shapes
  • Database schema — every table and column, with FK relationships and inline notes
  • Internal functions — every exported helper in src/lib/

The plan is to generate these from the source code (and from migrations/*.sql for the schema), rather than hand-write them. Hand-written reference docs go stale; generated ones don't.

Drafted from planning · v0.1

The generators are stubs (scripts/generate-schema-docs.ts, etc.). The goal is to wire them as a pre-commit + CI step so that the reference section refreshes on every PR.

Until the generators are wired​

For schema reference, see:

  • The migration files in migrations/*.sql — authoritative
  • The entity pages in domain/entities — narrative explanations
  • kvick_helm_d1_schema.md in the Helm repo — original spec

For API reference, see:

  • The endpoint list in each slice page
  • The src/index.js switch statement — authoritative
  • The data flow diagrams — request/response patterns

For function reference, see:

  • The source code; functions are short and named for what they do

Planned subsections​

  • reference/api/ — one page per endpoint, generated from in-code OpenAPI annotations
  • reference/database/ — one page per table, generated from schema introspection
  • reference/functions/ — one page per exported function, generated from JSDoc

See also​