Automated architecture documentation for the NDX (National Digital Exchange) Innovation Sandbox ecosystem.
This repository maintains living documentation of the NDX/ISB infrastructure by:
- Discovering all related GitHub repositories and AWS resources
- Analyzing code, configurations, and infrastructure-as-code
- Generating comprehensive architecture documentation
- Tracking changes and detecting drift over time
The system is designed to be run periodically by AI agents following structured prompts.
- Read the main instructions:
update.prompt- this is the primary execution guide - Run validation:
./scripts/validate.sh --allto check documentation quality - View generated docs: Browse the
docs/directory
| Document | Description |
|---|---|
docs/ |
Generated architecture documentation |
docs/00-index.md |
Documentation index and navigation |
AGENTS.md |
AI agent instructions for maintaining docs |
update.prompt |
Main execution instructions |
| Script | Purpose |
|---|---|
scripts/validate.sh |
Run quality gates and validation checks |
scripts/diff-state.sh |
Show changes since last documentation capture |
scripts/regenerate.sh |
Force documentation regeneration |
If you're an AI agent working on this repository:
- Start here: Read
AGENTS.mdfor orientation - Execute tasks: Follow
update.promptfor structured workflows - Validate work: Run
./scripts/validate.sh --allbefore committing
ndx-try-arch/
├── update.prompt # Main execution instructions
├── AGENTS.md # AI agent instructions
├── README.md # This file
├── docs/ # Generated documentation (committed)
│ ├── *.md # Documentation files
│ └── .meta/ # Provenance and metadata
├── repos/ # Cloned repositories (gitignored)
├── .state/ # Runtime state (gitignored)
└── scripts/ # Helper scripts
Internal use only - Crown Copyright.