doc-u-me¶

Your documentation brain and blocker dashboard

Doc-u-me continuously indexes all F3L1X documentation (162+ markdown files) and surfaces blockers—unchecked tasks that prevent progress. It's the connective tissue between your planning docs and execution, preventing work from getting lost.

What It Does¶

Doc-u-me watches your documentation ecosystem and answers three critical questions:

Where is information? - Full-text search across 162+ markdown files
What's blocking progress? - Extract incomplete tasks from your activity logs
Are docs current? - Compare documentation to actual codebase state

When you write "- [ ] Task pending" in your ACTIVITY_LOG.md, doc-u-me extracts it and surfaces it as a blocker. When you complete it with "- [x] Task completed", it disappears.

Key Capabilities¶

Full-Text Search¶

Fast Indexing: Search results in <100ms across all docs
Markdown Parsing: Understands headers, links, code blocks
Compressed Index: 38.9x compression ratio keeps memory footprint small
Cross-Reference Detection: Find related documents automatically

Blocker Extraction & Tracking¶

Activity Log Scanning: Extracts "- [ ]" items as blockers
Priority Levels: High/medium/low classification by context
Auto-Clearing: Completed tasks marked "- [x]" disappear
Blocker Dashboard: Visual summary of what's preventing progress

Documentation Health¶

Dead Link Detection: Finds broken internal references
Orphaned Files: Identifies docs not linked from anywhere
Staleness Detection: Marks docs not updated in 60+ days
Index Generation: Creates compressed index.json for fast lookups

Integration with CI/CD¶

init.sh Support: Check blockers before session starts
GitHub Actions: Fail builds if high-priority blockers exist
Claude Code Awareness: Blockers surface in /hello greeting

Accessing doc-u-me¶

Web Dashboard¶

URL: http://127.0.0.1:8005

The doc-u-me dashboard shows:
- Search bar for full-text queries
- Blocker tracker with unchecked tasks
- Documentation health metrics
- Recently modified documents

Search Interface¶

Search by:
- Keywords: "supabase", "authentication", "deployment"
- Filename: "POST-MORTEM", "ACTIVITY_LOG"
- Content: Full-text queries find content anywhere in docs
- Project: Filter to specific realm docs

Blocker Commands¶

# Check blockers for current project
python manage.py blockers --project <realm-name>

# Show only high-priority blockers
python manage.py blockers --priority high

# Show all blockers across ecosystem
python manage.py blockers --all

Common Use Cases¶

Use Case 1: Start a New Work Session¶

Goal: Understand what's blocking progress before you begin

Open doc-u-me dashboard at :8005
Click "Active Blockers" section
Review all "- [ ]" items listed
Sort by priority (high/medium/low)
Make blockers part of your session plan

Use Case 2: Search for Implementation Details¶

Goal: Find how a specific feature was implemented

Use search bar: "query optimization" or "REST API"
Results show matching documentation sections
Click any result to jump to full document
Follow implementation patterns

Use Case 3: Track Your Session Work¶

Goal: Document progress and surface blockers for next session

In your ACTIVITY_LOG.md:

## 2026-02-17 (Session 42) - Build Authentication

### What Happened
1. Refactored login form validation
2. Added email confirmation flow

### Files Modified
| auth/forms.py | Added email validator |

### Next Steps
- [x] Email confirmation working
- [ ] SMTP setup for production (blocker: waiting for Felix to provide credentials)
- [ ] Rate limiting on login attempts

Doc-u-me extracts the unchecked items as blockers, preventing them from being lost.

Goal: Build context before implementing a feature

Search "Supabase integration"
Results show all mentions across 162+ files
Includes previous incidents, guides, examples
Build complete picture of approach

Important Notes¶

Activity Log Format (CRITICAL)¶

Location: active/{realm}/ACTIVITY_LOG.md (NOT docs/sessions/)

## YYYY-MM-DD (Session N) - Title
### What Happened
1. Action taken
### Files Modified
| File | Purpose |
### Next Steps
- [ ] Unchecked = blocker (doc-u-me extracts these)
- [x] Checked = completed

Why this location matters:
- docs/sessions/ is legacy dead storage (POST-MORTEM-2026-02-04, 2026-02-05)
- Doc-u-me only monitors active/{realm}/ACTIVITY_LOG.md
- Tools and automation expect activity logs in realm directories
- Moving logs to wrong location causes loss of blockers

Search Index¶

Doc-u-me generates a compressed index.json that enables:
- Fast searches across 162+ files
- Cross-project hyperlinks
- Auto-completion of document names
- Usage in external tools

Regenerate index: python manage.py generate

Privacy & Scope¶

Doc-u-me only reads:
- Documentation in docs/ directory
- Activity logs in active/{realm}/ACTIVITY_LOG.md
- Reference materials in reference/
- Does NOT read source code, config files, or secrets

Troubleshooting¶

Search returns no results¶

Symptom: Valid keyword finds nothing
Fix: Run python manage.py scan to re-index all documents

Blockers not appearing¶

Symptom: Completed "- [ ]" items in ACTIVITY_LOG.md don't show as blockers
Fix: Check file location is active/{realm}/ACTIVITY_LOG.md (not docs/sessions/)

Documentation health shows stale docs¶

Symptom: Docs marked as "not updated in 60+ days"
Fix: Update relevant date in front matter or content

Index.json too large¶

Symptom: Search performance degraded
Fix: Run python manage.py generate --compress to optimize

Dead links detected¶

Symptom: Dashboard shows broken references
Fix: Update broken links or delete orphaned docs

pipeline-go - Methodology that defines ACTIVITY_LOG format
worker-bee - Uses doc-u-me blockers to prioritize ecosystem work
All active realms - Should maintain ACTIVITY_LOG.md with blockers