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 API documentation to reflect accurate data shape requirements

Browse Source 
Introduce new documentation files for API v1 compatibility and data shape requirements, refining existing audit documents to detail input/output shape handling and test coverage.

Replit-Commit-Author: Agent
Replit-Commit-Session-Id: fbbf36df-818c-4b8c-8760-4975515f38e6
Replit-Commit-Checkpoint-Type: intermediate_checkpoint
Replit-Commit-Event-Id: e1680535-aae4-4ef6-a90a-fabeb9668ae7
Replit-Helium-Checkpoint-Created: true
This commit is contained in:
bewest
2026-01-19 13:14:21 -08:00
committed by Ben West
parent 2c59f072eb
commit 9ede11480b
6 changed files with 1025 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files
replit.md
+11
View File
@@ -206,6 +206,17 @@ A revised proposal aligning test modernization with broader UI and architecture
- Out-of-scope items logged and deferred
- No new UI module without test strategy
## Documentation Structure
### Requirements & Specifications
Located in `docs/requirements/` and `docs/test-specs/`:
| Document | Description |
|----------|-------------|
| `requirements/data-shape-requirements.md` | Formal requirements for single vs array input handling |
| `requirements/api-v1-compatibility-spec.md` | Client compatibility requirements (AAPS, Loop, xDrip) |
| `test-specs/shape-handling-test-spec.md` | Test case specifications with requirement traceability |
## Comprehensive System Audit Documentation
A complete audit of the Nightscout codebase covering all major subsystems, created to support system understanding and modernization planning.