Commit aede507
authored
docs: fix broken MessageDelivery API reference links in state_variables.md (#23801)
## What
Fixes the 3 broken API reference links flagged by the docs
`validate:api-ref-links` checker (reported in #docs-alerts against PR
#23695):
```
docs-developers/docs/aztec-nr/framework-description/state_variables.md
-> aztec-nr-api/mainnet/noir_aztec/messages/message_delivery/struct.MessageDelivery
```
## Why they were broken (validated)
The links targeted
`struct.MessageDelivery#method.{onchain_constrained,onchain_unconstrained,offchain}`.
In the docs build `#api_ref_version` resolves to **`mainnet`** (v4.3.0),
and the committed `static/aztec-nr-api/mainnet/` snapshot does **not**
contain `struct.MessageDelivery.html`. In v4.3.0 the symbol is exposed
as a global:
- `noir_aztec/messages/message_delivery/global.MessageDelivery.html` ✓
(exists)
- `noir_aztec/messages/message_delivery/struct.MessageDeliveryEnum.html`
✓ (exists)
- `noir_aztec/messages/message_delivery/struct.MessageDelivery.html` ✗
(does not exist)
The page source was updated to describe the newer method-based
`MessageDelivery` struct API (which matches current `next` code and the
`#include_code` example on the page), but `#api_ref_version` still pins
API-ref links to the released mainnet snapshot, so
`struct.MessageDelivery` 404s. The prose/examples are left unchanged
because they correctly match the current code.
These links are **pre-existing on `next`**; PR #23695 only touches
governance/token docs and did not introduce them — the checker simply
surfaced them on that PR.
## Fix
Repoint the three links to `global.MessageDelivery`, the page that
documents `MessageDelivery` in the pinned mainnet API. The per-method
anchors are dropped since the global page has none.
## Validation
`scripts/validate_api_ref_links.sh` over the preprocessed page (with
`#api_ref_version` resolved to `mainnet`):
- Before: `Broken links: 3`
- After: `Broken links: 0` (`Version mismatches: 0`)
---
*Created by
[claudebox](https://claudebox.work/v2/sessions/97d92d02ac088b2d) ·
group: `slackbot`*1 file changed
Lines changed: 3 additions & 3 deletions
Lines changed: 3 additions & 3 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
273 | 273 | | |
274 | 274 | | |
275 | 275 | | |
276 | | - | |
277 | | - | |
278 | | - | |
| 276 | + | |
| 277 | + | |
| 278 | + | |
279 | 279 | | |
280 | 280 | | |
281 | 281 | | |
| |||
0 commit comments