MallGuide

Level 4 — 17/20 | mallguide-docs.pages.dev | GitHub

Checklist

Level 1: Foundation ✅

• [x] VitePress config
• [x] Home page
• [x] Getting started
• [x] Auto-deploy (Cloudflare Pages)
• [x] Gitignore

Level 2: Structure ✅

• [ ] Auto-discovered sidebar (uses manual sidebar config — works but needs manual edits)
• [x] Subdirectories (guide/, architecture/, data-pipeline/, research/, adr/)
• [x] Local search
• [x] Last updated

Level 3: Decisions & Diagrams ✅

• [x] ADR directory with 3 decisions
• [x] Mermaid plugin
• [x] Architecture diagrams
• [x] Alternatives documented in ADRs

Level 4: API & Types ✅

• [x] API reference (cloud-functions.md with all endpoints)
• [x] Data models documented
• [x] Environment variables documented

Level 5: Polish

• [ ] Versioned docs
• [ ] Changelog page
• [x] Access control references

What's Missing

1. Auto-discovered sidebar — currently uses manual sidebar config in config.mts. Should switch to readdirSync pattern.
2. Changelog page — could auto-generate from git tags.
3. Versioned docs — not needed until prod deploy.

Stats

• 28 pages across 5 sections
• 3 ADRs (rotation, no-backfill, budget kill switch)
• Mermaid diagrams in ADRs