Skip to content

Commit 8fbe9fe

Browse files
committed
docs: Minimize CLAUDE.md with hybrid architecture
Reduce from 2.2k to 1.2k chars (44% reduction) by: - Removing redundant ecosystem info (now in lumos/CLAUDE.md) - Removing duplicate AI guidelines (now in central file) - Keeping only documentation-specific details - Referencing ecosystem context from central CLAUDE.md REPO-SPECIFIC INFO PRESERVED: - VitePress site structure - Local development commands - Cloudflare Pages deployment setup - Key pages to maintain Related: #36
1 parent 6c68ee8 commit 8fbe9fe

File tree

1 file changed

+4
-40
lines changed

1 file changed

+4
-40
lines changed

CLAUDE.md

Lines changed: 4 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,6 @@
11
# CLAUDE.md - LUMOS Documentation
22

3-
**Repository:** https://github.com/getlumos/docs-lumos
4-
**Website:** https://lumos-lang.org
5-
**Purpose:** Official documentation site (VitePress)
3+
> **Ecosystem Context:** See [getlumos/lumos/CLAUDE.md](https://github.com/getlumos/lumos/blob/main/CLAUDE.md) for LUMOS ecosystem overview, cross-repo standards, and shared guidelines.
64
75
---
86

@@ -23,7 +21,7 @@ docs-lumos/
2321
## Local Development
2422

2523
```bash
26-
npm install # Install dependencies
24+
npm install
2725
npm run docs:dev # Dev server (localhost:5173)
2826
npm run docs:build # Build for production
2927
npm run docs:preview # Preview build
@@ -36,26 +34,8 @@ npm run docs:preview # Preview build
3634
**Platform:** Cloudflare Pages
3735
**Domain:** lumos-lang.org
3836
**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 |
5137

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.
38+
**Build:** `npm run docs:build``.vitepress/dist/`
5939

6040
---
6141

@@ -68,21 +48,5 @@ npm run docs:preview # Preview build
6848

6949
---
7050

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
51+
**Last Updated:** 2025-11-22
8852
**Status:** Live at https://lumos-lang.org

0 commit comments

Comments
 (0)