53 lines
1.8 KiB
Markdown
53 lines
1.8 KiB
Markdown
|
# Root Index — Sankofa Phoenix
|
||
|
|
|
||
|
|
_Quick navigation for newcomers and auditors_
|
||
|
|
_Last updated: 2026-01-31_
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Start Here
|
||
|
|
|
||
|
|
**New to this repository?** Start with these documents:
|
||
|
|
|
||
|
|
1. **[PROJECT_STRUCTURE.md](./PROJECT_STRUCTURE.md)**
|
||
|
|
Project and directory structure
|
||
|
|
|
||
|
|
2. **[docs/MASTER_INDEX.md](./docs/MASTER_INDEX.md)**
|
||
|
|
Documentation index (architecture, deployment, services)
|
||
|
|
|
||
|
|
3. **[docs/README.md](./docs/README.md)**
|
||
|
|
Documentation overview
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Additional Context
|
||
|
|
|
||
|
|
**Understanding the architecture:**
|
||
|
|
- [docs/MASTER_INDEX.md](./docs/MASTER_INDEX.md) — Documentation index
|
||
|
|
- [docs/02-architecture/NETWORK_ARCHITECTURE.md](./docs/02-architecture/NETWORK_ARCHITECTURE.md) — Network architecture
|
||
|
|
- [PROJECT_STRUCTURE.md](./PROJECT_STRUCTURE.md) — Project structure
|
||
|
|
|
||
|
|
**For operations:**
|
||
|
|
- [docs/MASTER_INDEX.md](./docs/MASTER_INDEX.md) — Documentation index
|
||
|
|
- [docs/00-meta/NEXT_STEPS_MASTER.md](./docs/00-meta/NEXT_STEPS_MASTER.md) — Next steps master list (single source of truth)
|
||
|
|
- [scripts/README.md](./scripts/README.md) — Scripts guide (incl. CCIP WETH9 Bridge deploy: `scripts/deploy-and-configure-weth9-bridge-chain138.sh --dry-run` then live; set `CCIPWETH9_BRIDGE_CHAIN138` after deploy)
|
||
|
|
- `scripts/` — Automation and deployment scripts
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
## Navigation Principles
|
||
|
|
|
||
|
|
This repository is organized with **intentional flexibility**:
|
||
|
|
|
||
|
|
- **Flat + Indexed:** High-signal docs at root, detailed structure in directory reference
|
||
|
|
- **Three-Layer Separation:** Control plane / Core systems / Ops evidence (mental model, not mandate)
|
||
|
|
- **Canonical vs Experimental:** Explicit labels, but no rigid boundaries
|
||
|
|
- **Related by Interface:** Packages connected by relationship, not hierarchy
|
||
|
|
|
||
|
|
**See [docs/MASTER_INDEX.md](./docs/MASTER_INDEX.md) for full documentation.**
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated:** 2026-01-31
|
||
|
|
**Status:** Navigation index (non-constraining)
|