Context
The indexer's schema is generated by codegen and its types are gitignored
(AGENTS.md §5). A hand-written schema page would be stale within a sprint, so
this one is generated from the same source and drift-checked in CI.
Scope
- A generator producing
content/reference/graphql.generated.mdx from the
indexer's schema, with a "do not edit" banner.
- Document every type, field, query, and argument, with descriptions taken from
schema comments so they live next to the code.
- Include example queries for the common cases: positions by account, recent
trades, market state.
- Run indexer codegen before generating — any script compiling the indexer must
(AGENTS.md §5).
- CI fails on drift between committed output and a fresh run.
Acceptance criteria
Out of scope
- Running the indexer locally (DX-089).
Spec: docs/dx_1/001_docs_site.md §6 · Depends on: DX-087
Context
The indexer's schema is generated by codegen and its types are gitignored
(
AGENTS.md§5). A hand-written schema page would be stale within a sprint, sothis one is generated from the same source and drift-checked in CI.
Scope
content/reference/graphql.generated.mdxfrom theindexer's schema, with a "do not edit" banner.
schema comments so they live next to the code.
trades, market state.
(
AGENTS.md§5).Acceptance criteria
are shown.
Out of scope
Spec:
docs/dx_1/001_docs_site.md§6 · Depends on: DX-087