mirror of
https://github.com/bckelley/cgm-remote-monitor.git
synced 2026-08-24 03:14:12 -05:00
bewestandBen West
14f92611dd
Adjusted internal documentation links and updated references within various Markdown files to reflect a new directory structure for audit and meta documents. Replit-Commit-Author: Agent Replit-Commit-Session-Id: 4dee684a-a4b9-4c32-a818-3a27dae1b027 Replit-Commit-Checkpoint-Type: intermediate_checkpoint Replit-Commit-Event-Id: 971b8c75-c322-4ede-98ea-eb5ae31d4e5c Replit-Helium-Checkpoint-Created: true
3.9 KiB
3.9 KiB
Nightscout Documentation Index
This index provides navigation for the Nightscout documentation structure. Each folder has a specific purpose to help developers and AI agents quickly find relevant information.
Documentation Taxonomy
| Folder | Purpose | When to Use |
|---|---|---|
audits/ |
System analysis and current state documentation | Understanding existing architecture, identifying issues |
meta/ |
Project-level navigation and progress tracking | High-level orientation, roadmaps, overall progress |
requirements/ |
Formal requirements specifications by area | Defining what must be true for correctness |
test-specs/ |
Test specifications with progress tracking | Writing tests, tracking coverage gaps |
proposals/ |
RFC-style proposals for new features | Proposing changes, reviewing designs |
data-schemas/ |
Collection and field documentation | Understanding data structures |
plugins/ |
Plugin-specific documentation | Working with specific plugins |
Quick Navigation
Meta (Start Here)
- Architecture Overview - System design and component relationships
- Modernization Roadmap - Future direction and priorities
- Documentation Progress - What's been documented, what's pending
System Audits
- API Layer Audit - REST endpoints (v1, v2, v3)
- Data Layer Audit - MongoDB collections and storage
- Security Audit - Authentication, authorization, vulnerabilities
- Real-Time Systems Audit - Socket.IO, WebSocket handling
- Messaging Subsystem Audit - Notifications, alerts
- Plugin Architecture Audit - Plugin system design
- Dashboard UI Audit - Frontend components
Requirements
- Data Shape Requirements - Input/output shape handling
- Authorization Security Requirements - Auth system requirements
- API v1 Compatibility Requirements - Client compatibility
Test Specifications
- Shape Handling Tests - Array/object normalization tests
- Authorization Tests - Security and auth tests
- Coverage Gaps - Aggregated test gaps by priority
Data Schemas
- Treatments Schema - Treatment collection fields
- Profiles Schema - Profile structure
Proposals
- OIDC Actor Identity - Verified actor identity RFC
- Agent Control Plane - AI agent collaboration design
- Testing Modernization - Test framework updates
- MongoDB Modernization - Driver upgrade plan
For AI Agents
When working in this codebase:
- Start with INDEX.md (this file) to orient yourself
- Check test-specs/ for the area you're working on - each spec tracks its own progress and gaps
- Check requirements/ for formal correctness criteria
- Check audits/ for current implementation details
- Update the relevant test-spec's Progress section when you make discoveries
Quine-Style Iteration Pattern
Each test area is self-contained with:
- Requirements (what must be true)
- Test specifications (how to verify)
- Progress tracking (what's done, what's discovered)
- Priority gaps (what to work on next)
This allows focused iteration on one topical area at a time.