Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
53 changes: 27 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -98,10 +98,10 @@ AnchorKit/

### Prerequisites

| Tool | Min | Notes |
| --- | --- | --- |
| Node.js | 20.x | Required for all packages + web |
| pnpm | 9.x | Required package manager; install via `npm i -g pnpm@9` if needed |
| Tool | Min | Notes |
| --------------- | ----- | ----------------------------------------------------------------------------------------------------- |
| Node.js | 20.x | Required for all packages + web |
| pnpm | 9.x | Required package manager; install via `npm i -g pnpm@9` if needed |
| Rust (optional) | 1.81+ | Only for `contracts/treasury-escrow` tests and builds; needs `wasm32-unknown-unknown` target + clippy |

### Install and run
Expand Down Expand Up @@ -164,29 +164,30 @@ AnchorKit is testnet-first and secret-safe by design:

All of these live under [`./docs/`](./docs/).

| Topic | File |
| --- | --- |
| Project overview | [`PROJECT_OVERVIEW.md`](./docs/PROJECT_OVERVIEW.md) |
| Local setup | [`LOCAL_SETUP.md`](./docs/LOCAL_SETUP.md) |
| Architecture / package boundaries | [`ARCHITECTURE.md`](./docs/ARCHITECTURE.md) |
| Stellar testnet usage | [`STELLAR_TESTNET_USAGE.md`](./docs/STELLAR_TESTNET_USAGE.md) |
| Security notes | [`SECURITY_NOTES.md`](./docs/SECURITY_NOTES.md) |
| Topic | File |
| ---------------------------------------- | --------------------------------------------------------------------------- |
| Project overview | [`PROJECT_OVERVIEW.md`](./docs/PROJECT_OVERVIEW.md) |
| End-to-end developer journey | [`DEVELOPER_JOURNEY.md`](./docs/DEVELOPER_JOURNEY.md) |
| Local setup | [`LOCAL_SETUP.md`](./docs/LOCAL_SETUP.md) |
| Architecture / package boundaries | [`ARCHITECTURE.md`](./docs/ARCHITECTURE.md) |
| Stellar testnet usage | [`STELLAR_TESTNET_USAGE.md`](./docs/STELLAR_TESTNET_USAGE.md) |
| Security notes | [`SECURITY_NOTES.md`](./docs/SECURITY_NOTES.md) |
| Security & architecture readiness review | [`SECURITY_ARCHITECTURE_REVIEW.md`](./docs/SECURITY_ARCHITECTURE_REVIEW.md) |
| Secret key handling rules R0–R6 | [`SECRET_KEY_HANDLING.md`](./docs/SECRET_KEY_HANDLING.md) |
| Account utilities | [`ACCOUNT_UTILITIES.md`](./docs/ACCOUNT_UTILITIES.md) |
| Payment intent utilities | [`PAYMENT_INTENT_UTILITIES.md`](./docs/PAYMENT_INTENT_UTILITIES.md) |
| Anchor utilities | [`ANCHOR_UTILITIES.md`](./docs/ANCHOR_UTILITIES.md) |
| Soroban treasury escrow contract | [`SOROBAN_ESCROW_CONTRACT.md`](./docs/SOROBAN_ESCROW_CONTRACT.md) |
| Shared error taxonomy | [`ERROR_TAXONOMY.md`](./docs/ERROR_TAXONOMY.md) |
| Escrow storage migration guide | [`ESCROW_MIGRATION.md`](./docs/ESCROW_MIGRATION.md) |
| Contributor guide | [`CONTRIBUTOR_GUIDE.md`](./docs/CONTRIBUTOR_GUIDE.md) |
| Maintainer guide | [`MAINTAINER_GUIDE.md`](./docs/MAINTAINER_GUIDE.md) |
| Issue writing guide | [`ISSUE_WRITING_GUIDE.md`](./docs/ISSUE_WRITING_GUIDE.md) |
| GrantFox contribution workflow | [`GRANTFOX_WORKFLOW.md`](./docs/GRANTFOX_WORKFLOW.md) |
| Advanced issue standard | [`ISSUE_STANDARD.md`](./docs/ISSUE_STANDARD.md) |
| Maintainer review checklist | [`MAINTAINER_REVIEW_CHECKLIST.md`](./docs/MAINTAINER_REVIEW_CHECKLIST.md) |
| Automation runbook | [`AUTOMATION_RUNBOOK.md`](./docs/AUTOMATION_RUNBOOK.md) |
| Roadmap | [`ROADMAP.md`](./docs/ROADMAP.md) |
| Secret key handling rules R0–R6 | [`SECRET_KEY_HANDLING.md`](./docs/SECRET_KEY_HANDLING.md) |
| Account utilities | [`ACCOUNT_UTILITIES.md`](./docs/ACCOUNT_UTILITIES.md) |
| Payment intent utilities | [`PAYMENT_INTENT_UTILITIES.md`](./docs/PAYMENT_INTENT_UTILITIES.md) |
| Anchor utilities | [`ANCHOR_UTILITIES.md`](./docs/ANCHOR_UTILITIES.md) |
| Soroban treasury escrow contract | [`SOROBAN_ESCROW_CONTRACT.md`](./docs/SOROBAN_ESCROW_CONTRACT.md) |
| Shared error taxonomy | [`ERROR_TAXONOMY.md`](./docs/ERROR_TAXONOMY.md) |
| Escrow storage migration guide | [`ESCROW_MIGRATION.md`](./docs/ESCROW_MIGRATION.md) |
| Contributor guide | [`CONTRIBUTOR_GUIDE.md`](./docs/CONTRIBUTOR_GUIDE.md) |
| Maintainer guide | [`MAINTAINER_GUIDE.md`](./docs/MAINTAINER_GUIDE.md) |
| Issue writing guide | [`ISSUE_WRITING_GUIDE.md`](./docs/ISSUE_WRITING_GUIDE.md) |
| GrantFox contribution workflow | [`GRANTFOX_WORKFLOW.md`](./docs/GRANTFOX_WORKFLOW.md) |
| Advanced issue standard | [`ISSUE_STANDARD.md`](./docs/ISSUE_STANDARD.md) |
| Maintainer review checklist | [`MAINTAINER_REVIEW_CHECKLIST.md`](./docs/MAINTAINER_REVIEW_CHECKLIST.md) |
| Automation runbook | [`AUTOMATION_RUNBOOK.md`](./docs/AUTOMATION_RUNBOOK.md) |
| Roadmap | [`ROADMAP.md`](./docs/ROADMAP.md) |

## 🦊 GrantFox readiness

Expand Down
1 change: 1 addition & 0 deletions docs/ARCHITECTURE.md
Original file line number Diff line number Diff line change
Expand Up @@ -862,6 +862,7 @@ Convenience alone is not a sufficient reason to reverse dependency direction.
## 18. Related documentation

- [Project Overview](./PROJECT_OVERVIEW.md)
- [End-to-End Developer Journey](./DEVELOPER_JOURNEY.md)
- [Local Setup](./LOCAL_SETUP.md)
- [Account Utilities](./ACCOUNT_UTILITIES.md)
- [Payment Intent Utilities](./PAYMENT_INTENT_UTILITIES.md)
Expand Down
3 changes: 3 additions & 0 deletions docs/CONTRIBUTOR_GUIDE.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,9 @@ technical, constructive, and respectful.
- `GrantFox OSS` + `Maybe Rewarded` + `Official Campaign | FWC26` are issues participating in
the GrantFox campaign. See [GRANTFOX_WORKFLOW.md](./GRANTFOX_WORKFLOW.md).

Start with the [DEVELOPER_JOURNEY.md](./DEVELOPER_JOURNEY.md) walkthrough to understand how the
monorepo modules fit together before diving into an issue.

## Quick contribution loop

1. Find an issue, or open a new one following the [ISSUE_STANDARD.md](./ISSUE_STANDARD.md).
Expand Down
Loading