@lunch-money/developer-docs

Documentation content for the Lunch Money developer APIs — the guides, v1/v2 reference docs, images, and doc-routing manifest that power the Lunch Money developer portal.

Most API consumers want the OpenAPI spec instead: @lunch-money/v2-api-spec is the canonical machine-readable API contract. This package is the human-facing docs content, primarily for the docs server that renders the portal.

What's in the package

Shipped verbatim at the package root:

• docs/ — version-independent guides (getting started, pagination, rate limiting, …)
• v1/ — v1 API reference markdown
• v2/ — v2 guides, images, and a convenience copy of the OpenAPI YAML under v2/spec/ (non-canonical; the canonical spec is @lunch-money/v2-api-spec)
• manifest.json — doc routes, redirects, and sidebar structure

Consuming the content

Resolve the package root, then read content files relative to it:

const path = require('path');
const fs = require('fs');

const docsRoot = path.dirname(require.resolve('@lunch-money/developer-docs/package.json'));
const intro = fs.readFileSync(path.join(docsRoot, 'docs/getting-started.md'), 'utf8');

manifest.json describes every page the docs server renders:

{
  "pages": [
    {
      "path": "/amounts-and-balances",        // canonical URL
      "file": "docs/amounts-and-balances.md",  // path within this package
      "title": "Amounts & Balances",
      "section": "GUIDES",                     // sidebar grouping
      "type": "markdown",                      // "markdown" | "html" | "v1-slate"
      "aliases": ["/v2/amounts-and-balances"]  // legacy URLs → 301 to path
    }
  ],
  "redirects": [ /* { from, to, status } */ ],
  "sidebar": { "docs": [ /* … */ ], "v1": [ /* … */ ] }
}

Versioning

The package version tracks the newest API version this content documents (e.g. 2.11.x documents the v2.11 API). Pin an exact version in server deployments so docs are deterministic.

Contributing

Guides, spec, and the routing manifest are edited in the public developer-docs repository — see its README for how to add or move a page. This npm package is a published build of that content.

ISC licensed.