bckelley/cgm-remote-monitor
1
0
Fork 0
mirror of https://github.com/bckelley/cgm-remote-monitor.git synced 2026-08-24 03:14:12 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation links and project references

Browse Source 
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
This commit is contained in:
bewest
2026-01-19 13:14:21 -08:00
committed by Ben West
parent 913a638a26
commit 14f92611dd
20 changed files with 145 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/INDEX.md
+75
View File
@@ -0,0 +1,75 @@
# 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](./meta/architecture-overview.md) - System design and component relationships
- [Modernization Roadmap](./meta/modernization-roadmap.md) - Future direction and priorities
- [Documentation Progress](./meta/DOCUMENTATION-PROGRESS.md) - What's been documented, what's pending
### System Audits
- [API Layer Audit](./audits/api-layer-audit.md) - REST endpoints (v1, v2, v3)
- [Data Layer Audit](./audits/data-layer-audit.md) - MongoDB collections and storage
- [Security Audit](./audits/security-audit.md) - Authentication, authorization, vulnerabilities
- [Real-Time Systems Audit](./audits/realtime-systems-audit.md) - Socket.IO, WebSocket handling
- [Messaging Subsystem Audit](./audits/messaging-subsystem-audit.md) - Notifications, alerts
- [Plugin Architecture Audit](./audits/plugin-architecture-audit.md) - Plugin system design
- [Dashboard UI Audit](./audits/dashboard-ui-audit.md) - Frontend components
### Requirements
- [Data Shape Requirements](./requirements/data-shape-requirements.md) - Input/output shape handling
- [Authorization Security Requirements](./requirements/authorization-security-requirements.md) - Auth system requirements
- [API v1 Compatibility Requirements](./requirements/api-v1-compatibility-requirements.md) - Client compatibility
### Test Specifications
- [Shape Handling Tests](./test-specs/shape-handling-tests.md) - Array/object normalization tests
- [Authorization Tests](./test-specs/authorization-tests.md) - Security and auth tests
- [Coverage Gaps](./test-specs/coverage-gaps.md) - Aggregated test gaps by priority
### Data Schemas
- [Treatments Schema](./data-schemas/treatments-schema.md) - Treatment collection fields
- [Profiles Schema](./data-schemas/profiles-schema.md) - Profile structure
### Proposals
- [OIDC Actor Identity](./proposals/oidc-actor-identity-proposal.md) - Verified actor identity RFC
- [Agent Control Plane](./proposals/agent-control-plane-rfc.md) - AI agent collaboration design
- [Testing Modernization](./proposals/testing-modernization-proposal.md) - Test framework updates
- [MongoDB Modernization](./proposals/mongodb-modernization-implementation-plan.md) - Driver upgrade plan
---
## For AI Agents
When working in this codebase:
1. **Start with INDEX.md** (this file) to orient yourself
2. **Check test-specs/** for the area you're working on - each spec tracks its own progress and gaps
3. **Check requirements/** for formal correctness criteria
4. **Check audits/** for current implementation details
5. **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.
docs/api-layer-audit.md → docs/audits/api-layer-audit.md
+5 -5
View File
@@ -519,13 +519,13 @@ Shape handling is validated by 38 tests across:
## 12. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Security Audit](./security-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
### Requirements & Specifications
- [Data Shape Requirements](./requirements/data-shape-requirements.md) - Formal requirements for input/output shapes
- [API v1 Compatibility Requirements](./requirements/api-v1-compatibility-requirements.md) - Client compatibility requirements
- [Shape Handling Tests](./test-specs/shape-handling-tests.md) - Test case specifications
- [Data Shape Requirements](../requirements/data-shape-requirements.md) - Formal requirements for input/output shapes
- [API v1 Compatibility Requirements](../requirements/api-v1-compatibility-requirements.md) - Client compatibility requirements
- [Shape Handling Tests](../test-specs/shape-handling-tests.md) - Test case specifications
docs/dashboard-ui-audit.md → docs/audits/dashboard-ui-audit.md
+2 -2
View File
@@ -594,7 +594,7 @@ DOM update
## 13. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Plugin Architecture Audit](./plugin-architecture-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
docs/data-layer-audit.md → docs/audits/data-layer-audit.md
+5 -5
View File
@@ -703,13 +703,13 @@ During driver upgrade testing, these issues were identified and fixed:
## 12. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [API Layer Audit](./api-layer-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
### Requirements & Specifications
- [Data Shape Requirements](./requirements/data-shape-requirements.md) - Formal requirements for input/output shapes
- [API v1 Compatibility Requirements](./requirements/api-v1-compatibility-requirements.md) - Client compatibility requirements
- [Shape Handling Tests](./test-specs/shape-handling-tests.md) - Test case specifications
- [Data Shape Requirements](../requirements/data-shape-requirements.md) - Formal requirements for input/output shapes
- [API v1 Compatibility Requirements](../requirements/api-v1-compatibility-requirements.md) - Client compatibility requirements
- [Shape Handling Tests](../test-specs/shape-handling-tests.md) - Test case specifications
docs/messaging-subsystem-audit.md → docs/audits/messaging-subsystem-audit.md
+2 -2
View File
@@ -669,7 +669,7 @@ Consider adding support for:
## 13. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Plugin Architecture Audit](./plugin-architecture-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
docs/plugin-architecture-audit.md → docs/audits/plugin-architecture-audit.md
+2 -2
View File
@@ -605,7 +605,7 @@ describe('myplugin', function() {
## 13. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Dashboard UI Audit](./dashboard-ui-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
docs/realtime-systems-audit.md → docs/audits/realtime-systems-audit.md
+2 -2
View File
@@ -587,7 +587,7 @@ io.use(rateLimit({
## 12. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Security Audit](./security-audit.md)
- [API Layer Audit](./api-layer-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
docs/security-audit.md → docs/audits/security-audit.md
+2 -2
View File
@@ -470,6 +470,6 @@ For EU users:
## 11. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [API Layer Audit](./api-layer-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
docs/DOCUMENTATION-PROGRESS.md → docs/meta/DOCUMENTATION-PROGRESS.md
View File
docs/architecture-overview.md → docs/meta/architecture-overview.md
+7 -7
View File
@@ -390,11 +390,11 @@ IP-based progressive delay for failed authentication attempts:
## 11. Related Documents
- [Security Audit](./security-audit.md)
- [API Layer Audit](./api-layer-audit.md)
- [Data Layer Audit](./data-layer-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Plugin Architecture Audit](./plugin-architecture-audit.md)
- [Dashboard UI Audit](./dashboard-ui-audit.md)
- [Messaging Subsystem Audit](./messaging-subsystem-audit.md)
- [Security Audit](../audits/security-audit.md)
- [API Layer Audit](../audits/api-layer-audit.md)
- [Data Layer Audit](../audits/data-layer-audit.md)
- [Real-Time Systems Audit](../audits/realtime-systems-audit.md)
- [Plugin Architecture Audit](../audits/plugin-architecture-audit.md)
- [Dashboard UI Audit](../audits/dashboard-ui-audit.md)
- [Messaging Subsystem Audit](../audits/messaging-subsystem-audit.md)
- [Modernization Roadmap](./modernization-roadmap.md)
docs/modernization-roadmap.md → docs/meta/modernization-roadmap.md
+7 -7
View File
@@ -744,10 +744,10 @@ async function sendNotification(notify) {
## 8. Related Documents
- [Architecture Overview](./architecture-overview.md)
- [Security Audit](./security-audit.md)
- [API Layer Audit](./api-layer-audit.md)
- [Data Layer Audit](./data-layer-audit.md)
- [Real-Time Systems Audit](./realtime-systems-audit.md)
- [Plugin Architecture Audit](./plugin-architecture-audit.md)
- [Dashboard UI Audit](./dashboard-ui-audit.md)
- [Messaging Subsystem Audit](./messaging-subsystem-audit.md)
- [Security Audit](../audits/security-audit.md)
- [API Layer Audit](../audits/api-layer-audit.md)
- [Data Layer Audit](../audits/data-layer-audit.md)
- [Real-Time Systems Audit](../audits/realtime-systems-audit.md)
- [Plugin Architecture Audit](../audits/plugin-architecture-audit.md)
- [Dashboard UI Audit](../audits/dashboard-ui-audit.md)
- [Messaging Subsystem Audit](../audits/messaging-subsystem-audit.md)
docs/proposals/api-query-normalization.md
+4 -4
View File
@@ -4,7 +4,7 @@
**Authors:** Nightscout Community
**Created:** 2026-01-13
**Priority:** HIGH
**Related:** [API Layer Audit](../api-layer-audit.md), [Security Audit](../security-audit.md)
**Related:** [API Layer Audit](../audits/api-layer-audit.md), [Security Audit](../audits/security-audit.md)
---
@@ -740,10 +740,10 @@ If significant issues detected:
## 17. Related Documents
- [API Layer Audit](../api-layer-audit.md) - Documents the issues this proposal addresses
- [Security Audit](../security-audit.md) - Related security concerns
- [API Layer Audit](../audits/api-layer-audit.md) - Documents the issues this proposal addresses
- [Security Audit](../audits/security-audit.md) - Related security concerns
- [Agent Control Plane RFC](./agent-control-plane-rfc.md) - Future API direction
- [Modernization Roadmap](../modernization-roadmap.md) - Overall modernization context
- [Modernization Roadmap](../meta/modernization-roadmap.md) - Overall modernization context
---
docs/proposals/oidc-actor-identity-proposal.md
+3 -3
View File
@@ -803,9 +803,9 @@ To ensure this proposal aligns with Nightscout Core maintainer expectations:
### Internal Documents
- [Authorization and Security Requirements](../requirements/authorization-security-requirements.md)
- [Architecture Overview](../architecture-overview.md)
- [Security Audit](../security-audit.md)
- [Modernization Roadmap](../modernization-roadmap.md)
- [Architecture Overview](../meta/architecture-overview.md)
- [Security Audit](../audits/security-audit.md)
- [Modernization Roadmap](../meta/modernization-roadmap.md)
### External Standards
docs/requirements/api-v1-compatibility-requirements.md
+2 -2
View File
@@ -3,7 +3,7 @@
**Document Version:** 1.0
**Last Updated:** January 2026
**Status:** Draft
**Related Documents:** [Data Shape Requirements](./data-shape-requirements.md), [API Layer Audit](../api-layer-audit.md)
**Related Documents:** [Data Shape Requirements](./data-shape-requirements.md), [API Layer Audit](../audits/api-layer-audit.md)
---
@@ -341,4 +341,4 @@ The shape-handling test suite validates these requirements:
- [Loop Documentation](https://loopkit.github.io/loopdocs/)
- [xDrip+ Documentation](https://xdrip.readthedocs.io/)
- [Data Shape Requirements](./data-shape-requirements.md)
- [API Layer Audit](../api-layer-audit.md)
- [API Layer Audit](../audits/api-layer-audit.md)
docs/requirements/authorization-security-requirements.md
+4 -4
View File
@@ -3,7 +3,7 @@
**Document Version:** 1.0
**Last Updated:** January 2026
**Status:** Draft
**Related Documents:** [Security Audit](../security-audit.md), [API Layer Audit](../api-layer-audit.md)
**Related Documents:** [Security Audit](../audits/security-audit.md), [API Layer Audit](../audits/api-layer-audit.md)
---
@@ -501,7 +501,7 @@ See [OIDC Actor Identity Proposal](../proposals/oidc-actor-identity-proposal.md)
## 12. References
- [Security Audit](../security-audit.md) - Security analysis and recommendations
- [API Layer Audit](../api-layer-audit.md) - API endpoint inventory
- [Modernization Roadmap](../modernization-roadmap.md) - OIDC/OAuth2 plans
- [Security Audit](../audits/security-audit.md) - Security analysis and recommendations
- [API Layer Audit](../audits/api-layer-audit.md) - API endpoint inventory
- [Modernization Roadmap](../meta/modernization-roadmap.md) - OIDC/OAuth2 plans
- `lib/authorization/` - Implementation source code
docs/requirements/data-shape-requirements.md
+3 -3
View File
@@ -3,7 +3,7 @@
**Document Version:** 1.0
**Last Updated:** January 2026
**Status:** Draft
**Related Audits:** [API Layer Audit](../api-layer-audit.md), [Data Layer Audit](../data-layer-audit.md)
**Related Audits:** [API Layer Audit](../audits/api-layer-audit.md), [Data Layer Audit](../audits/data-layer-audit.md)
---
@@ -224,7 +224,7 @@ The `data-received` event triggering data updates is throttled to 15 seconds (`U
## 8. References
- [API Layer Audit](../api-layer-audit.md) - Endpoint inventory and response formats
- [Data Layer Audit](../data-layer-audit.md) - MongoDB collection schemas
- [API Layer Audit](../audits/api-layer-audit.md) - Endpoint inventory and response formats
- [Data Layer Audit](../audits/data-layer-audit.md) - MongoDB collection schemas
- [Shape Handling Tests](../test-specs/shape-handling-tests.md) - Detailed test cases
- [API v1 Compatibility Requirements](./api-v1-compatibility-requirements.md) - Client compatibility requirements
docs/test-specs/authorization-tests.md
+1 -1
View File
@@ -520,6 +520,6 @@ Per `docs/proposals/testing-modernization-proposal.md`:
## 13. References
- [Authorization Security Requirements](../requirements/authorization-security-requirements.md)
- [Security Audit](../security-audit.md)
- [Security Audit](../audits/security-audit.md)
- [Testing Modernization Proposal](../proposals/testing-modernization-proposal.md)
- Test files in `tests/` directory
docs/test-specs/coverage-gaps.md
+1 -1
View File
@@ -77,4 +77,4 @@ When addressing a gap:
- [Shape Handling Tests](shape-handling-tests.md)
- [Authorization Tests](authorization-tests.md)
- [Documentation Progress](../DOCUMENTATION-PROGRESS.md)
- [Documentation Progress](../meta/DOCUMENTATION-PROGRESS.md)
docs/test-specs/shape-handling-tests.md
+1 -1
View File
@@ -363,5 +363,5 @@ The test `rapid duplicate submissions result in single persisted document with l
- [Data Shape Requirements](../requirements/data-shape-requirements.md)
- [API v1 Compatibility Requirements](../requirements/api-v1-compatibility-requirements.md)
- [API Layer Audit](../api-layer-audit.md)
- [API Layer Audit](../audits/api-layer-audit.md)
- Test files in `tests/` directory
replit.md
+17
View File
@@ -67,6 +67,23 @@ Key insights from schema documentation:
- The `eventType` field is essentially free-form - controllers can send any value
- Report plugins serve as implicit schema documentation by revealing which fields are actually used
## Documentation Structure
Documentation is organized into purpose-specific folders. Start at `docs/INDEX.md` for navigation.
| Folder | Purpose |
|--------|---------|
| `docs/meta/` | Project-level navigation: architecture overview, modernization roadmap, documentation progress |
| `docs/audits/` | System analysis: API, data layer, security, real-time, plugin, messaging, dashboard audits |
| `docs/requirements/` | Formal requirements by area (shape handling, authorization, API v1 compatibility) |
| `docs/test-specs/` | Test specifications with progress tracking; each area tracks its own gaps |
| `docs/proposals/` | RFC-style proposals for new features (OIDC, control plane, testing modernization) |
| `docs/data-schemas/` | Collection and field documentation (treatments, profiles) |
| `docs/plugins/` | Plugin-specific documentation |
### For AI Agents
Each test area is self-contained with requirements, test specs, progress tracking, and priority gaps. This enables focused iteration on one topical area at a time. See `docs/INDEX.md` for the full taxonomy.
## Test Documentation
Test specifications and requirements are organized in `docs/test-specs/` and `docs/requirements/`. Each test area tracks its own progress, discoveries, and coverage gaps.