@lunch-money/developer-docs 2.11.1-preview.2 → 2.11.1-preview.3

package/README.md

@@ -1,24 +1,65 @@
 # @lunch-money/developer-docs
 
-Developer documentation content for Lunch Money APIs.
+Documentation content for the [Lunch Money](https://lunchmoney.app) developer APIs —
+the guides, v1/v2 reference docs, images, and doc-routing manifest that power the
+[Lunch Money developer portal](https://lunchmoney.dev).
 
-This package ships the public `developer-docs` repository content directories at the package root:
+Most API consumers want the OpenAPI spec instead: **[`@lunch-money/v2-api-spec`](https://www.npmjs.com/package/@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.
 
-- `docs/`
-- `v1/`
-- `v2/`
-- `manifest.json`
+## What's in the package
 
-The package version tracks the newest API version documented by this content. Server consumers should pin this package explicitly and resolve the package root with:
+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:
 
 ```js
+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');
 ```
 
-The OpenAPI YAML under `v2/spec/` is included as a convenience copy because the docs tree is shipped verbatim. The canonical v2 API specification package is `@lunch-money/v2-api-spec`.
+`manifest.json` describes every page the docs server renders:
+
+```jsonc
+{
+  "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.
 
-## Updating Routes and Sidebar
+## Contributing
 
-The docs server reads `manifest.json` from the package root. When adding or moving a documentation page, update the content file and add a matching manifest entry with `path`, `file`, `title`, `section`, and `type`.
+Guides, spec, and the routing manifest are edited in the public
+[`developer-docs` repository](https://github.com/lunch-money/developer-docs) — see its
+README for how to add or move a page. This npm package is a published build of that
+content.
 
-Run `npm run pack:docs` from the repository root before publishing. The package validates the manifest during `prepack` and fails if paths collide, aliases are duplicated, or referenced files are missing.
+_ISC licensed._

package/docs/introduction.md

@@ -2,10 +2,6 @@
 
 Welcome to the Lunch Money developer documentation. This site covers the **v2 API** — the current generation of the Lunch Money API — along with guides, a reference for the legacy v1 API, and tools for exploring the API without touching real data.
 
-> [!WARNING]
-> Alpha Release
-> The v2 API is in open alpha. It is subject to change during this review period and bugs may exist. We strongly encourage using the [mock service](#trying-the-api-without-real-data) or a test budget with sample data as your first step.
-
 ## Getting Started
 
 The v2 API is available at:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lunch-money/developer-docs",
-  "version": "2.11.1-preview.2",
+  "version": "2.11.1-preview.3",
   "description": "Developer documentation content for Lunch Money APIs",
   "exports": {
     ".": "./package.json",

package/v2/spec/lunch-money-api-v2.yaml

@@ -2,11 +2,13 @@ openapi: 3.0.2
 info:
   title: Lunch Money API - v2
   description: |-
+    Welcome to the Lunch Money v2 API reference. This is the **v2.11.1** spec.
+
     ### Introduction
 
-    The API is available at `https://api.lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
+    The API is available at `https://lunchmoney.dev/v2`. Get your access token from the [Lunch Money developers page](https://my.lunchmoney.app/developers).
 
-    <span class="red-text"><strong>The v2 API is in open alpha and is still subject to change. Use the mock server or a test budget when getting started.</strong></span>
+    API calls can <span class="red-text"><strong>change or delete</strong></span> your data. Any changes you make are <span class="red-text"><strong>permanent</strong></span>, just like they would be if you made changes using the web or mobile app.   Please refer to the [Getting Started Guide](https://lunchmoney.dev/v2/getting-started) before using the API.
 
     **Static Mock Server**
 
@@ -18,15 +20,15 @@ info:
 
     **Migrating from v1**
 
-    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide) for details.
+    The v2 API is not backwards compatible with v1. See the [Migration Guide](https://lunchmoney.dev/v2/migration-guide) for details.
 
     **Useful links**
-    - [Developer Portal](https://alpha.lunchmoney.dev/v2/introduction)
-    - [Getting Started Guide](https://alpha.lunchmoney.dev/v2/getting-started)
-    - [v2 API Overview](https://alpha.lunchmoney.dev/v2/overview)
-    - [Version History](https://alpha.lunchmoney.dev/v2/version-history)
-    - [Migration Guide](https://alpha.lunchmoney.dev/v2/migration-guide)
-    - [Rate Limits](https://alpha.lunchmoney.dev/v2/rate-limits)
+    - [Developer Portal](https://lunchmoney.dev/v2/introduction)
+    - [Getting Started Guide](https://lunchmoney.dev/v2/getting-started)
+    - [v2 API Overview](https://lunchmoney.dev/v2/overview)
+    - [Version History](https://lunchmoney.dev/v2/version-history)
+    - [Migration Guide](https://lunchmoney.dev/v2/migration-guide)
+    - [Rate Limits](https://lunchmoney.dev/v2/rate-limits)
   termsOfService: https://lunchmoney.dev/#current-status
   contact:
     email: devsupport@lunchmoney.app
@@ -38,8 +40,8 @@ info:
 servers:
   - url: https://api.lunchmoney.dev/v2
     description: v2 Lunch Money API Server - changes will affect real data!
-#  - url: https://mock.lunchmoney.dev/v2
-  - url: https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/
+#  - url: https://lunchmoney.dev/v2
+  - url: https://lunchmoney.dev/v2
     description: Static mock version of the v2 Lunch Money API Server
 
 tags:
@@ -2940,7 +2942,7 @@ components:
         currency:
           description: Three-letter lowercase currency code of the transaction
             in ISO 4217 format. Must match one of the [supported
-            currencies](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/currencies). If not set
+            currencies](https://lunchmoney.dev/v2/currencies). If not set
             defaults to the user account's primary currency.
           allOf:
             - $ref: "#/components/schemas/currencyEnum"
@@ -9097,19 +9099,19 @@ paths:
           description: Sets the maximum number of transactions to return. If
             more match the filter criteria, the response will include a
             `has_more` attribute set to `true`. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
         - name: offset
           in: query
           schema:
             type: integer
           description: Sets the offset for the records returned. This is
             typically set automatically in the header. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
       responses:
         "200":
           description: Returns an array of transactions. <br><br>The `has_more`
             property is set to `true` if more transactions are available. See
-            [Pagination](https://lm-v2-api-next-a7fabcab8e9a.herokuapp.com/v2/pagination)
+            [Pagination](https://lunchmoney.dev/v2/pagination)
           content:
             application/json:
               schema: