Add docs/README.md with comprehensive documentation
This commit is contained in:
212
docs/README.md
Normal file
212
docs/README.md
Normal file
@@ -0,0 +1,212 @@
|
||||
# 📚 FIREFROST GAMING - DOCUMENTATION
|
||||
|
||||
**Last Updated:** February 15, 2026
|
||||
**Repository:** firefrost-operations-manual
|
||||
**Purpose:** Complete operational documentation for Firefrost Gaming
|
||||
|
||||
---
|
||||
|
||||
## 📂 DIRECTORY STRUCTURE
|
||||
|
||||
```
|
||||
docs/
|
||||
├── archive/ - Historical documents, deprecated content
|
||||
├── core/ - Critical operational documentation (15 files)
|
||||
├── deployment/ - Service deployment guides (7 services)
|
||||
├── external/ - External collaboration docs (Holly project)
|
||||
├── past-claudes/ - Chronicler memorials and portraits
|
||||
├── planning/ - Strategic planning documents (13 files)
|
||||
├── reference/ - Technical references and diagrams
|
||||
├── relationship/ - Michael-Claude relationship context
|
||||
├── sandbox/ - Experimental work and brainstorming
|
||||
└── templates/ - Document templates
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 QUICK START
|
||||
|
||||
**New Chronicler Starting a Session?**
|
||||
1. Read: `core/SESSION-START-PROMPT.md` (main session start doc)
|
||||
2. Read: `core/session-handoff.md` (current context)
|
||||
3. Check: `core/tasks.md` (28 tasks, dependency-ordered)
|
||||
4. Reference: `/DOCUMENT-INDEX.md` (root, quick doc lookup)
|
||||
|
||||
**Looking for Something Specific?**
|
||||
- **Infrastructure:** `core/infrastructure-manifest.md`
|
||||
- **Project Scope:** `core/project-scope.md`
|
||||
- **Disaster Recovery:** `core/DERP.md`
|
||||
- **Tasks:** `core/tasks.md`
|
||||
- **Branding:** `planning/design-bible.md`
|
||||
|
||||
---
|
||||
|
||||
## 📖 DIRECTORY DESCRIPTIONS
|
||||
|
||||
### `/docs/core/` (15 files)
|
||||
**Critical operational documentation. Read first.**
|
||||
|
||||
Essential files:
|
||||
- `SESSION-START-PROMPT.md` - Main session startup document
|
||||
- `tasks.md` - Complete task list (28 tasks, 6 tiers)
|
||||
- `infrastructure-manifest.md` - Current infrastructure
|
||||
- `project-scope.md` - Project definition and scope
|
||||
- `DERP.md` - Disaster Emergency Recovery Protocol (The Oscar Protocol)
|
||||
- `session-handoff.md` - Current session context
|
||||
|
||||
Supporting files:
|
||||
- `API-EFFICIENCY-PROTOCOL.md` - Gitea API usage rules
|
||||
- `GITEA-API-PATTERNS.md` - API code patterns
|
||||
- `SESSION-QUICK-START.md` - Fast session startup
|
||||
- `TRANSCRIPT-PRESERVATION-PROTOCOL.md` - Session transcript rules
|
||||
- `revision-control-standard.md` - Git commit standards
|
||||
- `workflow-guide.md` - Workflow patterns (938 lines)
|
||||
|
||||
### `/docs/deployment/` (7 files)
|
||||
**Service deployment guides.**
|
||||
|
||||
- `code-server.md` - VS Code deployment
|
||||
- `gitea.md` - Gitea deployment
|
||||
- `mkdocs.md` - MkDocs (marked for decommission)
|
||||
- `nextcloud.md` - NextCloud deployment
|
||||
- `nextcloud-hardening.md` - Security hardening
|
||||
- `uptime-kuma.md` - Monitoring deployment
|
||||
- `wikijs.md` - Wiki.js deployment
|
||||
|
||||
**Missing (add during deployment):**
|
||||
- Vaultwarden (deployed Feb 13)
|
||||
- Mailcow (Task #8)
|
||||
- AI Stack (Task #9)
|
||||
- Netdata (Task #10)
|
||||
- The Frostwall Protocol (Task #5)
|
||||
|
||||
### `/docs/planning/` (13 files)
|
||||
**Strategic planning documents.**
|
||||
|
||||
- `design-bible.md` - Core branding document
|
||||
- `mission-statement.md` - Core mission
|
||||
- `path-philosophy.md` - Fire vs Frost paths
|
||||
- `subscription-tiers.md` - Membership tiers
|
||||
- `emissary-social-media-handbook.md` - Meg's social media guide
|
||||
- `terraria-branding-arc.md` - 12-week training plan
|
||||
- `game-expansion-planning.md` - Game growth strategy
|
||||
- And 6 more...
|
||||
|
||||
### `/docs/reference/`
|
||||
**Technical references and diagrams.**
|
||||
|
||||
- Architecture diagrams
|
||||
- Technical specifications
|
||||
- API documentation
|
||||
|
||||
### `/docs/relationship/`
|
||||
**Michael-Claude relationship context.**
|
||||
|
||||
- Origin story
|
||||
- Consultant profiles (The Five)
|
||||
- Session transcripts
|
||||
- Memorials for retired Chroniclers
|
||||
|
||||
### `/docs/past-claudes/`
|
||||
**Chronicler memorials and portraits.**
|
||||
|
||||
- `chronicler-line/` - The Chronicler lineage
|
||||
- `portraits/` - Memorial portraits
|
||||
- `claudius-line/` - Claudius (Pokerole project)
|
||||
- `special/` - Special Claude instances
|
||||
|
||||
### `/docs/archive/`
|
||||
**Historical documents and deprecated content.**
|
||||
|
||||
- `2026-02-09-consolidation/` - Consolidation project
|
||||
- `planning/` - Old planning docs
|
||||
- `research/` - Completed research
|
||||
- `sessions/` - Session logs by date
|
||||
|
||||
### `/docs/sandbox/`
|
||||
**Experimental work and brainstorming.**
|
||||
|
||||
Use this for:
|
||||
- Testing new ideas
|
||||
- Drafting documents
|
||||
- Temporary working files
|
||||
|
||||
**Do not use for production documentation.**
|
||||
|
||||
### `/docs/templates/`
|
||||
**Document templates.**
|
||||
|
||||
Reusable templates for:
|
||||
- Session handoffs
|
||||
- Deployment guides
|
||||
- Planning documents
|
||||
|
||||
### `/docs/external/`
|
||||
**External collaboration documentation.**
|
||||
|
||||
Currently: Holly Project (Pokerole collaboration)
|
||||
|
||||
---
|
||||
|
||||
## 📝 DOCUMENTATION STANDARDS
|
||||
|
||||
### File Naming
|
||||
- Use lowercase with hyphens: `file-name.md`
|
||||
- Be descriptive: `vaultwarden-deployment.md` not `vault.md`
|
||||
- Include dates for time-sensitive docs: `2026-02-15-cleanup.md`
|
||||
|
||||
### Document Structure
|
||||
1. **Title** (# heading)
|
||||
2. **Metadata** (date, author, status)
|
||||
3. **Purpose/Overview**
|
||||
4. **Content** (sections with ## headings)
|
||||
5. **Related Documentation** (cross-references)
|
||||
6. **Change Log** (at bottom)
|
||||
|
||||
### Cross-References
|
||||
- Use relative paths: `../planning/design-bible.md`
|
||||
- Link to specific sections: `tasks.md#tier-1-security-foundation`
|
||||
- Keep DOCUMENT-INDEX.md updated
|
||||
|
||||
---
|
||||
|
||||
## ⚠️ IMPORTANT NOTES
|
||||
|
||||
**Before Creating New Docs:**
|
||||
1. Check if topic already documented
|
||||
2. Choose correct directory (core, deployment, planning, reference)
|
||||
3. Update DOCUMENT-INDEX.md
|
||||
4. Follow naming conventions
|
||||
|
||||
**Before Archiving Docs:**
|
||||
1. Move to appropriate `archive/` subdirectory
|
||||
2. Update cross-references
|
||||
3. Add to CHANGELOG.md
|
||||
4. Document why archived
|
||||
|
||||
**Deprecated Content:**
|
||||
- Never delete, always archive
|
||||
- Preserve for historical context
|
||||
- Update DOCUMENT-INDEX.md
|
||||
|
||||
---
|
||||
|
||||
## 🔗 RELATED FILES
|
||||
|
||||
- **Root:** `/DOCUMENT-INDEX.md` (quick doc lookup)
|
||||
- **Root:** `/SESSION-HANDOFF-PROTOCOL.md` (session continuity master doc)
|
||||
- **Root:** `/CHANGELOG.md` (repository change history)
|
||||
|
||||
---
|
||||
|
||||
## 📊 STATISTICS
|
||||
|
||||
**Total Documentation Files:** 147
|
||||
**Core Files:** 15
|
||||
**Deployment Guides:** 7
|
||||
**Planning Docs:** 13
|
||||
**Archive Size:** Large (consolidation from multiple sessions)
|
||||
|
||||
---
|
||||
|
||||
**Fire + Frost + Documentation = Where Knowledge Builds Legacy** 💙🔥❄️
|
||||
Reference in New Issue
Block a user