|
| 1 | +# CLAUDE.md - LUMOS Documentation |
| 2 | + |
| 3 | +**Repository:** https://github.com/getlumos/docs-lumos |
| 4 | +**Website:** https://lumos-lang.org |
| 5 | +**Purpose:** Official documentation site (VitePress) |
| 6 | + |
| 7 | +--- |
| 8 | + |
| 9 | +## Site Structure |
| 10 | + |
| 11 | +``` |
| 12 | +docs-lumos/ |
| 13 | +├── .vitepress/config.ts # Site configuration |
| 14 | +├── index.md # Homepage |
| 15 | +├── guide/ # Getting started |
| 16 | +├── reference/ # Language reference |
| 17 | +├── examples/ # Code examples |
| 18 | +└── api/ # CLI/library API |
| 19 | +``` |
| 20 | + |
| 21 | +--- |
| 22 | + |
| 23 | +## Local Development |
| 24 | + |
| 25 | +```bash |
| 26 | +npm install # Install dependencies |
| 27 | +npm run docs:dev # Dev server (localhost:5173) |
| 28 | +npm run docs:build # Build for production |
| 29 | +npm run docs:preview # Preview build |
| 30 | +``` |
| 31 | + |
| 32 | +--- |
| 33 | + |
| 34 | +## Deployment |
| 35 | + |
| 36 | +**Platform:** Cloudflare Pages |
| 37 | +**Domain:** lumos-lang.org |
| 38 | +**Auto-deploy:** Push to `main` → live |
| 39 | +**Build:** `npm run docs:build` → `.vitepress/dist/` |
| 40 | + |
| 41 | +--- |
| 42 | + |
| 43 | +## Content Organization |
| 44 | + |
| 45 | +| Section | Audience | Purpose | |
| 46 | +|---------|----------|---------| |
| 47 | +| **guide/** | New users | Zero to first schema in 15 min | |
| 48 | +| **reference/** | Active developers | Complete syntax/behavior docs | |
| 49 | +| **examples/** | All users | Copy-paste patterns | |
| 50 | +| **api/** | Integrators | CLI commands, library API | |
| 51 | + |
| 52 | +--- |
| 53 | + |
| 54 | +## Documentation Standards |
| 55 | + |
| 56 | +**Writing:** Clear, concise, code examples for every concept. |
| 57 | +**Code Examples:** Complete, runnable, show generated output. |
| 58 | +**Structure:** Progressive disclosure (simple → complex), cross-referenced, search-friendly. |
| 59 | + |
| 60 | +--- |
| 61 | + |
| 62 | +## Key Pages to Maintain |
| 63 | + |
| 64 | +- `guide/installation.md` - Update on version changes |
| 65 | +- `reference/types.md` - Keep type mapping table current |
| 66 | +- `examples/*` - Add real-world patterns |
| 67 | +- `CHANGELOG.md` - Update every release |
| 68 | + |
| 69 | +--- |
| 70 | + |
| 71 | +## AI Assistant Guidelines |
| 72 | + |
| 73 | +**DO:** Sync with lumos-core releases, test all examples, update versions, cross-reference. |
| 74 | + |
| 75 | +**DON'T:** Document unimplemented features, use outdated syntax, skip testing, create orphaned pages. |
| 76 | + |
| 77 | +--- |
| 78 | + |
| 79 | +## Related Repositories |
| 80 | + |
| 81 | +- **lumos** - Core library (docs document this) |
| 82 | +- **awesome-lumos** - Examples (docs links to these) |
| 83 | +- **vscode-lumos** - VSCode extension (docs covers usage) |
| 84 | + |
| 85 | +--- |
| 86 | + |
| 87 | +**Last Updated:** 2025-11-20 |
| 88 | +**Status:** Live at https://lumos-lang.org |
0 commit comments