b3a8fe4496
Some checks failed
Deploy to Phoenix / deploy (push) Has been cancelled
- Config, docs, scripts, and backup manifests - Submodule refs unchanged (m = modified content in submodules) Made-with: Cursor
70 lines
5.0 KiB
Markdown
70 lines
5.0 KiB
Markdown
# Documentation — Master Index
|
||
|
||
**Last Updated:** 2026-03-02
|
||
**Purpose:** Single entry point for all project documentation. Use this index to find canonical sources and avoid deprecated or duplicate content.
|
||
|
||
**Status:** Preflight and Chain 138 next steps completed 2026-03-02 (38/38 on-chain, 12 c* GRU-registered). **Remaining:** Full deployment order Phase 0–6, operator tasks, Gnosis/Celo/Wemix CCIP, LINK relay, repos and PRs, E2E waves — see [00-meta/NEXT_STEPS_AND_REMAINING_TODOS.md](00-meta/NEXT_STEPS_AND_REMAINING_TODOS.md) § Remaining tasks.
|
||
|
||
---
|
||
|
||
## Start here
|
||
|
||
| Purpose | Document |
|
||
|--------|----------|
|
||
| **What to do next** | [00-meta/NEXT_STEPS_INDEX.md](00-meta/NEXT_STEPS_INDEX.md) — ordered actions, by audience, execution plan |
|
||
| **Your personal checklist** | [00-meta/NEXT_STEPS_FOR_YOU.md](00-meta/NEXT_STEPS_FOR_YOU.md) |
|
||
| **Operator runbook (LAN/creds)** | [00-meta/NEXT_STEPS_OPERATOR.md](00-meta/NEXT_STEPS_OPERATOR.md) |
|
||
| **Required / optional / recommended (full plan)** | [00-meta/COMPLETE_REQUIRED_OPTIONAL_RECOMMENDED_INDEX.md](00-meta/COMPLETE_REQUIRED_OPTIONAL_RECOMMENDED_INDEX.md) |
|
||
| **Single task list** | [00-meta/TODOS_CONSOLIDATED.md](00-meta/TODOS_CONSOLIDATED.md) |
|
||
| **Still not done (operator/external)** | [00-meta/STILL_NOT_DONE_EXECUTION_CHECKLIST.md](00-meta/STILL_NOT_DONE_EXECUTION_CHECKLIST.md) |
|
||
| **Remaining tasks (one page)** | [00-meta/REMAINING_TASKS.md](00-meta/REMAINING_TASKS.md) |
|
||
| **Task check report (verify before completing)** | [00-meta/TASK_CHECK_REPORT.md](00-meta/TASK_CHECK_REPORT.md) |
|
||
| **Gaps status (all gap sources + fixes)** | [00-meta/GAPS_STATUS.md](00-meta/GAPS_STATUS.md) |
|
||
|
||
---
|
||
|
||
## Master lists (canonical)
|
||
|
||
| Topic | Canonical document | Do not use (deprecated/superseded) |
|
||
|-------|--------------------|-------------------------------------|
|
||
| Next steps | [00-meta/NEXT_STEPS_INDEX.md](00-meta/NEXT_STEPS_INDEX.md), [00-meta/NEXT_STEPS_AND_REMAINING_TODOS.md](00-meta/NEXT_STEPS_AND_REMAINING_TODOS.md) | — |
|
||
| Recommendations (139+ items) | [00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md](00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md) | [ALL_IMPROVEMENTS_AND_GAPS_INDEX.md](ALL_IMPROVEMENTS_AND_GAPS_INDEX.md) — superseded; redirect only |
|
||
| Optional / recommendations index | [OPTIONAL_RECOMMENDATIONS_INDEX.md](OPTIONAL_RECOMMENDATIONS_INDEX.md) | — |
|
||
| Task list | [00-meta/TODO_TASK_LIST_MASTER.md](00-meta/TODO_TASK_LIST_MASTER.md), [00-meta/TODOS_CONSOLIDATED.md](00-meta/TODOS_CONSOLIDATED.md) | — |
|
||
| Deployment order | [03-deployment/DEPLOYMENT_ORDER_OF_OPERATIONS.md](03-deployment/DEPLOYMENT_ORDER_OF_OPERATIONS.md) | — |
|
||
| Operational runbooks | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) | RUNBOOKS_MASTER_INDEX.md — use OPERATIONAL_RUNBOOKS as single source |
|
||
| Contract / address status | [11-references/ADDRESS_MATRIX_AND_STATUS.md](11-references/ADDRESS_MATRIX_AND_STATUS.md) | CONTRACT_INVENTORY_AND_VERIFICATION (deleted) |
|
||
|
||
---
|
||
|
||
## By area
|
||
|
||
| Area | Index / key doc |
|
||
|------|-----------------|
|
||
| **00-meta** (tasks, next steps, phases) | [00-meta/NEXT_STEPS_INDEX.md](00-meta/NEXT_STEPS_INDEX.md), [00-meta/PHASES_AND_TASKS_MASTER.md](00-meta/PHASES_AND_TASKS_MASTER.md) |
|
||
| **02-architecture** | [02-architecture/](02-architecture/) |
|
||
| **03-deployment** | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md), [03-deployment/DEPLOYMENT_ORDER_OF_OPERATIONS.md](03-deployment/DEPLOYMENT_ORDER_OF_OPERATIONS.md) |
|
||
| **04-configuration** | [04-configuration/README.md](04-configuration/README.md) |
|
||
| **06-besu** | [06-besu/MASTER_INDEX.md](06-besu/MASTER_INDEX.md) |
|
||
| **07-ccip** | [07-ccip/](07-ccip/), [00-meta/CW_BRIDGE_TASK_LIST.md](00-meta/CW_BRIDGE_TASK_LIST.md) |
|
||
| **11-references** | [11-references/ADDRESS_MATRIX_AND_STATUS.md](11-references/ADDRESS_MATRIX_AND_STATUS.md), [11-references/CONTRACT_ADDRESSES_REFERENCE.md](11-references/CONTRACT_ADDRESSES_REFERENCE.md) |
|
||
| **Runbooks** | [03-deployment/OPERATIONAL_RUNBOOKS.md](03-deployment/OPERATIONAL_RUNBOOKS.md) |
|
||
|
||
---
|
||
|
||
## Deprecated / superseded (do not use as primary source)
|
||
|
||
| Document | Use instead |
|
||
|----------|-------------|
|
||
| [ALL_IMPROVEMENTS_AND_GAPS_INDEX.md](ALL_IMPROVEMENTS_AND_GAPS_INDEX.md) | [00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md](00-meta/ALL_RECOMMENDATIONS_AND_IMPROVEMENTS_LIST.md) |
|
||
| CONTRACT_INVENTORY_AND_VERIFICATION, SMART_CONTRACTS_INVENTORY | [11-references/ADDRESS_MATRIX_AND_STATUS.md](11-references/ADDRESS_MATRIX_AND_STATUS.md) |
|
||
| Dated one-off reviews (e.g. DOCUMENTATION_REVIEW_20260216) | In [archive/00-meta-pruned/](archive/00-meta-pruned/); use living docs above |
|
||
|
||
---
|
||
|
||
## Consolidation and maintenance
|
||
|
||
- **Archive candidates:** [00-meta/ARCHIVE_CANDIDATES.md](00-meta/ARCHIVE_CANDIDATES.md)
|
||
- **Consolidation plan:** [00-meta/DOCUMENTATION_CONSOLIDATION_PLAN.md](00-meta/DOCUMENTATION_CONSOLIDATION_PLAN.md)
|
||
- **Task list review (deprecated/duplicates resolved):** [00-meta/TASK_LIST_REVIEW_2026_03_01.md](00-meta/TASK_LIST_REVIEW_2026_03_01.md)
|