Skip to content

Add frontmatter description to ~20 high-value docs missing them #1204

@dkijania

Description

@dkijania

Background

PR #1203 added an auto-generator for llms.txt that skips any page whose frontmatter has no description field. The build prints a warning listing these pages — there are 237 in total today, but the picture is concentrated:

Count Section Action
217 zkapps/o1js-reference/ Skip — auto-generated API reference. Doesn't belong in the discovery-layer index. The generator should be updated to globally exclude this subtree (cheap follow-up).
9 node-developers/ Add descriptions — real content pages
6 using-mina/ Add descriptions — end-user-facing
4 participate/ Already excluded at top-level by the generator. No action.
1 node-operators/block-producer-node/... Add description — operator-facing

So the actionable audit is ~16 hand-written pages, not 219. Each gains one line of frontmatter.

Pages needing descriptions

node-developers/ (9 pages)

  • node-developers/bip44.mdx
  • node-developers/code-review-guidelines.mdx
  • node-developers/codebase-overview.mdx
  • node-developers/contributing.mdx
  • node-developers/graphql-api.mdx
  • node-developers/index.mdx
  • node-developers/repository-structure.mdx
  • node-developers/sandbox-node.mdx
  • node-developers/style-guide.mdx

using-mina/ (6 pages)

  • using-mina/Protect-Your-MINA.mdx
  • using-mina/how-to-delegate.mdx
  • using-mina/how-to-send-and-receive.mdx
  • using-mina/how-to-use-zkapp.mdx
  • using-mina/install-a-wallet.mdx
  • using-mina/ledger-hardware-wallet.mdx

node-operators/ (1 page)

  • One page under node-operators/block-producer-node/ (build warning will name it on next regen)

Description quality bar

From the llmstxt.org spec and what the AI benchmark surfaced as useful: each description should answer "why would I fetch this URL?" — not just restate the title.

Bad Good
Documentation for graphql-api Mina daemon GraphQL endpoints, schema, common queries (account balance, block, mempool), authentication, port 3085 default
Style guide for OCaml code OCaml coding conventions for the Mina node — naming, formatting, module structure, error handling patterns

Target 10-30 words. Surface concrete things on the page — APIs, file paths, key numbers, prerequisites.

Generator follow-up (separate small PR)

Update scripts/generate-llms-index.mjs to skip the entire zkapps/o1js-reference/ subtree explicitly rather than relying on the missing-description filter. That removes 217 spurious warnings from every build and makes the remaining warnings actionable.

Why this matters

Tracks under #1195 (developer & AI discoverability). Each page added to llms.txt is one more entry that AI agents see when they fetch the docs index — directly improves the answer quality measured by the AI benchmark workflow (#1202). The current llms.txt index is at 123 pages; with these additions it'd be ~140 pages, with the gain concentrated on user-facing wallet/staking content (using-mina) and contributor-facing internal docs (node-developers).

Acceptance

  • All checkboxes above ticked
  • npm run check-llms-txt shows the new pages reflected in regenerated static/llms.txt
  • Each new description is 10-30 words and surfaces something not in the title
  • Optional: separate PR globally excludes zkapps/o1js-reference/ from the generator

🤖 Generated with Claude Code

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions