Commit e03f565
committed
docs: complete backport of #22543 with script improvements and skill updates
The original cherry-pick of 6fd76de carried only the first commit of
PR #22543's five-commit feature branch, leaving the script using the
pre-22543 build-required check and missing the SKILL.md/CLAUDE.md/README.md
documentation that landed alongside.
Bring this backport in line with PR #22543's final merged state:
- Replace the .sh `stdlib/dest/` build check with source-file + node_modules
checks (no yarn-project build needed).
- Apply the .ts generator improvements: optional handling order, array
parenthesization, BlockHash in BlockParameterSchema, JSDoc index fix,
name-aware example params, remarks rendering, fallback warnings.
- Add Step 5a (Regenerate Node API Reference) to release-network-docs
SKILL.md plus the matching Key Points entry.
- Document `yarn generate:node-api-reference` in docs/CLAUDE.md and add
the Node JSON-RPC API Reference section to docs/README.md.
- Regenerate docs-operate/.../node-api-reference.md against this branch's
yarn-project interfaces (64 methods, 55 node + 9 admin).
METHOD_GROUPS adjustments for this branch's API surface: re-add
getSlashPayloads to the admin group (still present in
aztec-node-admin.ts here) and drop getPredictedMinFees from the fees
group (not yet present here). The version-v2.1.11-ignition snapshot is
left untouched — its content reflects that release's API and would be
corrupted by regenerating against HEAD.1 parent de6e69f commit e03f565
6 files changed
Lines changed: 181 additions & 85 deletions
File tree
- .claude/skills/release-network-docs
- docs
- docs-operate/operators/reference
- scripts/node_api_reference_generation
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
21 | 21 | | |
22 | 22 | | |
23 | 23 | | |
24 | | - | |
| 24 | + | |
25 | 25 | | |
26 | 26 | | |
27 | 27 | | |
28 | 28 | | |
29 | 29 | | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
30 | 33 | | |
31 | 34 | | |
32 | 35 | | |
| |||
165 | 168 | | |
166 | 169 | | |
167 | 170 | | |
168 | | - | |
| 171 | + | |
| 172 | + | |
| 173 | + | |
| 174 | + | |
| 175 | + | |
| 176 | + | |
| 177 | + | |
| 178 | + | |
| 179 | + | |
| 180 | + | |
| 181 | + | |
| 182 | + | |
| 183 | + | |
| 184 | + | |
| 185 | + | |
| 186 | + | |
| 187 | + | |
| 188 | + | |
| 189 | + | |
| 190 | + | |
| 191 | + | |
| 192 | + | |
| 193 | + | |
169 | 194 | | |
170 | 195 | | |
171 | 196 | | |
| |||
284 | 309 | | |
285 | 310 | | |
286 | 311 | | |
| 312 | + | |
| 313 | + | |
| 314 | + | |
| 315 | + | |
287 | 316 | | |
288 | 317 | | |
289 | 318 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
29 | 29 | | |
30 | 30 | | |
31 | 31 | | |
| 32 | + | |
| 33 | + | |
32 | 34 | | |
33 | 35 | | |
34 | 36 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
270 | 270 | | |
271 | 271 | | |
272 | 272 | | |
| 273 | + | |
| 274 | + | |
| 275 | + | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| 306 | + | |
| 307 | + | |
| 308 | + | |
| 309 | + | |
| 310 | + | |
273 | 311 | | |
274 | 312 | | |
275 | 313 | | |
| |||
0 commit comments