Developer Docs

Use these docs when you are changing code, reviewing architecture, extending APIs, or preparing release-facing work. LIME is split between the Go Shopkeeper backend, the Next.js dashboard, PostgreSQL persistence, generated reports, and this static docs site.

Recommended path

1. Read Contributing before changing code or opening a PR.
2. Read Architecture to understand Shopkeeper, Profiler, Juicer, Sweetner, UI, and PostgreSQL.
3. Read Docs Site before changing public docs, screenshots, or GitHub Pages behavior.
4. Read Performance before touching large-scan reads, reports, caching, or pagination.
5. Read API for how the public API reference is maintained.
6. Use the full API Reference when integrating with Shopkeeper endpoints.
7. Read MCP For AI Tools when preparing AI-tool connectivity for the MCP endpoint.

Engineering rules

• Keep migrations forward-only and safe for existing self-hosted installs.
• Preserve large-scan behavior: first render should stay bounded, and details should load progressively.
• Prefer Postgres-first read models and indexes before adding new infrastructure.
• Keep report output deterministic and bounded unless a format explicitly promises full occurrence detail.
• Update docs and changelog entries for user-facing changes.