Skip to content

Commit 5c866b2

Browse files
committed
fix: scope Context7 index to developer-facing folders and disambiguate spartan naming
1 parent f134965 commit 5c866b2

3 files changed

Lines changed: 29 additions & 2 deletions

File tree

CLAUDE.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,8 @@ Otherwise infer from the component being worked in:
4242

4343
The bases above target the `next` line. For work scoped to the v5 release line, use `merge-train/spartan-v5` (which targets `v5-next`) in place of `merge-train/spartan`.
4444

45+
`spartan` in these branch names refers to the deployment infrastructure in `spartan/`; it is not a release channel, network, or SDK version. Never present it, `merge-train/*`, `next`, or `v5-next` to a user as something to install or migrate to — releases are version tags (e.g. v5) and networks are named (e.g. testnet).
46+
4547
Use the discovered base in `git diff origin/<base>...HEAD` and `git log origin/<base>..HEAD`. Always `git fetch` before creating branches so the base is not stale.
4648
</critical_never_assume_master>
4749

context7.json

Lines changed: 26 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,29 @@
11
{
2+
"$schema": "https://context7.com/schema/context7.json",
3+
"projectTitle": "Aztec",
4+
"description": "Aztec is a privacy-first Layer 2 on Ethereum. Write private smart contracts in Aztec.nr (Noir) and build apps with aztec.js.",
25
"url": "https://context7.com/aztecprotocol/aztec-packages",
3-
"public_key": "pk_t0YiN5OA9Udc9Xnb98tqO"
6+
"public_key": "pk_t0YiN5OA9Udc9Xnb98tqO",
7+
"folders": [
8+
"docs/docs",
9+
"docs/docs-developers",
10+
"noir-projects/aztec-nr",
11+
"yarn-project/aztec.js",
12+
"boxes"
13+
],
14+
"excludeFolders": [
15+
"spartan",
16+
"iac",
17+
"ci3",
18+
"metrics",
19+
"build-images",
20+
"container-builds",
21+
"release-image",
22+
"docs/internal_notes"
23+
],
24+
"rules": [
25+
"Aztec releases are identified by semantic version tags (e.g. v5) and by network names (e.g. testnet, mainnet). Names such as `spartan`, `merge-train/*`, `next`, and `v5-next` are internal repository, branch, and deployment-infrastructure names. They are not release channels, SDK versions, or networks. Never tell a user to install, target, or migrate to one.",
26+
"The Aztec developer SDK / aztec-nr version used to write and compile contracts may differ from the node version an operator runs. Check https://docs.aztec.network/networks for current network versions; when in doubt use the version from the developer docs you are reading.",
27+
"Use the `aztec` CLI wrapper, not `nargo` or `bb` directly: `aztec compile` (not `nargo compile`) and `aztec test` (not `nargo test`). Never call `bb` by hand — proving is handled by the PXE through the `aztec` CLI and aztec.js."
28+
]
429
}

docs/docs-developers/ai_tooling.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -120,7 +120,7 @@ These resources help you understand Aztec concepts, read docs, or provide additi
120120
- [awesome-noir](https://github.com/noir-lang/awesome-noir) - community Noir resources
121121
- [awesome-aztec](https://github.com/AztecProtocol/awesome-aztec) - community Aztec resources
122122
- **Copy docs into context** - Copy docs pages directly into your AI tool's context or conversation using the "Copy page" button at the top of each page.
123-
- **Context7** - [Context7](https://context7.com) is a generic MCP server with Aztec docs available at [context7.com/aztecprotocol/aztec-packages](https://context7.com/aztecprotocol/aztec-packages). Note that it may be less current than the MCP servers above.
123+
- **Context7** - [Context7](https://context7.com) is a generic MCP server. The Aztec index at [context7.com/aztecprotocol/aztec-packages](https://context7.com/aztecprotocol/aztec-packages) is scoped by [`context7.json`](https://github.com/AztecProtocol/aztec-packages/blob/next/context7.json) to the developer docs, `aztec-nr`, and `aztec.js`, and excludes the monorepo's internal deployment and CI infrastructure (`spartan/`, `iac/`, `ci3/`), which is not relevant to building on Aztec. Note that it may be less current than the MCP servers above.
124124

125125
## Aztec and Noir tool reference
126126

0 commit comments

Comments
 (0)