Context
Running the indexer locally is the highest-friction part of contributing to this
repository — Docker, codegen, a contracts manifest, and a sync step, each with
its own failure mode. Documenting it well removes the most common reason a
contributor gives up.
Scope
- What the indexer does and why the app depends on it.
- Local setup: Docker services,
codegen, build, and the local contracts sync
using the fixture repo, exactly as the integration checks run it.
- The contracts manifest: what it is, how it is validated, and how to point it
at a different deployment.
- The gitignored generated types and why codegen must run before any compile.
- Troubleshooting the real failures: missing types, manifest validation errors,
and sync failures.
Acceptance criteria
Out of scope
- Deploying the indexer to production.
Spec: docs/dx_1/003_content_map.md §2 · Depends on: DX-088
Context
Running the indexer locally is the highest-friction part of contributing to this
repository — Docker, codegen, a contracts manifest, and a sync step, each with
its own failure mode. Documenting it well removes the most common reason a
contributor gives up.
Scope
codegen,build, and the local contracts syncusing the fixture repo, exactly as the integration checks run it.
at a different deployment.
and sync failures.
Acceptance criteria
bug in one of them and must be reconciled.
check:contentandcheck:linkspass.Out of scope
Spec:
docs/dx_1/003_content_map.md§2 · Depends on: DX-088