Skip to content

Commit 774bb21

Browse files
add public repository review guide
1 parent 23b665c commit 774bb21

1 file changed

Lines changed: 104 additions & 0 deletions

File tree

docs/REVIEW_GUIDE.md

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# NEXUS FINANCE REVIEW GUIDE
2+
3+
## Overview
4+
5+
This guide is intended to help external reviewers navigate the public NEXUS Finance contracts repository in a structured and efficient way.
6+
7+
It is designed for:
8+
9+
- auditors
10+
- technical reviewers
11+
- ecosystem counterparties
12+
- accelerator reviewers
13+
- diligence-oriented investors
14+
15+
The goal is to make the repository easier to interpret without requiring readers to infer the intended review path on their own.
16+
17+
## Recommended Reading Order
18+
19+
For most reviewers, the recommended reading order is:
20+
21+
1. `README.md`
22+
2. `docs/ARCHITECTURE.md`
23+
3. `docs/STATUS.md`
24+
4. `docs/TESTNET_STATUS.md`
25+
5. `docs/RISK_MODEL.md`
26+
27+
This sequence provides a high-level understanding of protocol identity, architecture, current stage, testnet posture, and public contract risk design.
28+
29+
## Additional Documentation
30+
31+
After the core reading path, reviewers may continue with:
32+
33+
- `docs/AUDIT_PACKAGE.md`
34+
- `docs/CONSTITUTION.md`
35+
- `docs/CONTRACTS_CORE_SPEC.md`
36+
- `docs/MULTISIG_GOVERNANCE_ARCHITECTURE.md`
37+
38+
These materials provide more specific context around review support artifacts, constitutional structure, contract modules, and governance architecture.
39+
40+
## Repository Areas
41+
42+
Key public repository areas include:
43+
44+
- `src/` for core smart contracts
45+
- `script/` for canonical Foundry deployment, verification, and scenario scripts
46+
- `scripts/` for auxiliary repository utilities and generators
47+
- `docs/` for public-facing protocol documentation
48+
- `deployments/` for deployment-related public evidence
49+
- `audit_package/` for audit-oriented support artifacts
50+
- `constitution/` for the constitutional and invariant-oriented layer
51+
52+
## Review Notes
53+
54+
This repository is intended to expose the public smart contract surface and a structured documentation layer for NEXUS Finance.
55+
56+
It should be interpreted as a public contracts repository, not as an exhaustive exposure of every internal workflow, internal system component, or broader protocol-adjacent process.
57+
58+
## Reviewer Profiles
59+
60+
### For auditors and technical reviewers
61+
62+
Start with:
63+
64+
- `README.md`
65+
- `docs/ARCHITECTURE.md`
66+
- `docs/RISK_MODEL.md`
67+
- `docs/CONTRACTS_CORE_SPEC.md`
68+
69+
Then continue into:
70+
71+
- `src/`
72+
- `script/`
73+
- `deployments/`
74+
- `audit_package/`
75+
76+
### For ecosystem and accelerator reviewers
77+
78+
Start with:
79+
80+
- `README.md`
81+
- `docs/STATUS.md`
82+
- `docs/TESTNET_STATUS.md`
83+
- `docs/ARCHITECTURE.md`
84+
85+
Then continue into:
86+
87+
- `docs/MULTISIG_GOVERNANCE_ARCHITECTURE.md`
88+
- `deployments/`
89+
90+
### For diligence-oriented investors
91+
92+
Start with:
93+
94+
- `README.md`
95+
- `docs/STATUS.md`
96+
- `docs/TESTNET_STATUS.md`
97+
- `docs/ARCHITECTURE.md`
98+
- `docs/AUDIT_PACKAGE.md`
99+
100+
Then continue into deeper technical material only as needed.
101+
102+
## Summary
103+
104+
The public NEXUS Finance contracts repository is organized to support structured external review across architecture, risk posture, governance-aware controls, deployment evidence, and contract-level technical diligence.

0 commit comments

Comments
 (0)