Skip to content
Closed
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
32 changes: 28 additions & 4 deletions SPIKE-NOTES.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,33 @@ Not yet verified against the actual Mintlify dashboard for this account. Plan as

## Findings to feed back into the plan

- **PRD claim "407 pages":** actual EN .mdx count is **367**. Likely included deep `api-reference/` paths in the original count or counted both EN+ZH.
- **PRD claim "/quickstart in Get Started":** confirmed missing. `quickstart.mdx` exists at root but is **not** in [docs.json](docs.json) navigation. The audit lists it as orphan. Adding it to nav is a 1-line fix; week 4 will move it under `quickstart/nft.mdx` per WS-4.
- **PRD claim "407 pages":** actual EN .mdx count is **371** (with the chooser drafts). Likely included deep `api-reference/` paths or counted EN+ZH.
- **PRD claim "/quickstart in Get Started":** confirmed missing. `quickstart.mdx` exists at root but is **not** in [docs.json](docs.json) navigation. Audit row marked `action=Rewrite, new_url=quickstart/nft` — week 4 IA cutover handles it.
- **PRD claim "Orb has 11 sidebar items":** actual is **12** (1 landing + 11 explore pages).
- **PRD claim "getTransactionsForAddress in 3+ places":** actual is **24** `.mdx` files mention it.
- 19 orphan `api-reference/laserstream/websocket/*` pages — were these intentionally cut from nav, or is the WebSocket reference quietly broken? Audit owner to investigate.
- `validator-reporting/*` (7 pages) is fully orphaned — entire section not in nav. Audit owner: keep or delete?

## Orphan investigation (week 2)

37 orphan pages found by `npm run audit`. Annotated in [audit.csv](audit.csv) `notes` column. Summary:

| Orphan | Action | Notes |
|---|---|---|
| `AGENTS.mdx` | **Keep** | Machine-readable agents index served as `/docs/AGENTS.md` for AI consumers. Intentionally not in nav. |
| `api-reference/common-error-codes` | **Keep + wire into nav** | Full FAQ on HTTP error codes. Should be discoverable from API Reference. |
| `api-reference/laserstream/websocket/*` (19 pages) | **Keep + wire into nav** | Reference pages for LaserStream WebSocket subscriptions. Whoever set up the API Reference anchor wired in `laserstream-grpc` but missed the WebSocket equivalent. Add a "LaserStream WebSocket" group to the API Reference anchor (or fold into a unified `api-reference/websockets/` after WS-1 merge). |
| `event-listening` + `event-listening/quickstart` | **Merge → streaming/overview** | Orphan landing pages overlapping with `data-streaming.mdx`. Confirmed redundant. |
| `laserstream/websocket` | **Merge → websockets/overview** | Documents `transactionSubscribe` for LaserStream WebSocket — appears identical to Enhanced WebSockets. Eng to confirm before merge. |
| `rpc/http/get-accounts`, `rpc/http/get-transactions` | **Delete** | How-to pages duplicating content in `rpc/guides/`. |
| `validator-reporting/*` (7 pages) | **Keep, hidden** | Private partner API. Intentionally not in public nav. Confirm with Eng whether to keep documenting publicly or move to a partner-only docs surface. |
| `quickstart` | **Rewrite → quickstart/nft** | Already addressed; week-4 IA handles the move. |
| `snippets/quickstart` | n/a | Already excluded from audit (snippet, not a page). |

## Audit prefill coverage (week 2)

After mechanical prefill + orphan annotation:

- **diataxis_type filled:** 280 / 371 (75%)
- **action filled:** 284 / 371 (77%)
- **Remaining for human review:** 91 pages (mostly conceptual/mixed pages: `agents/overview`, `agents/cli`, `nfts/nft-compression`, `zk-compression/introduction`, top-level landing pages, billing pages)

Doc-team next step: open `audit.csv` in Sheets, filter `diataxis_type=""`, fill in the remaining 91 rows. Top-traffic pages first.
Loading
Loading