Update code examples that no longer compile
Examples written for an older version of the API, updated and then compiled automatically so they cannot become wrong again.
The ticket
Update documentation code examples and make them compile in the pipeline.
Acceptance criteria
- Every example compiles against the current API
- Examples are extracted and compiled in the pipeline
- A deliberately broken example fails the build
- Examples use the current recommended approach, not merely a working one
What lands as proof
A seeded broken example failing the build, which converts the examples from prose into tested code.
Why teams defer it
- Examples are the first thing a reader tries and the last thing anybody updates.
- Wiring them into the build takes an extraction step that nobody has built yet.
Questions
- What does the agent actually change?
- The ticket is scoped to one outcome: update documentation code examples and make them compile in the pipeline. Work that serves that outcome is in scope, and anything outside it is left for a separate ticket, so the pull request stays reviewable.
- How do I know the work is done?
- The pull request carries the evidence, not only the diff. Here that means examples compiled in CI so they cannot rot again, so a reviewer can confirm the result without reproducing the work locally.
- How much oversight does this need?
- The run stops once the plan is written. Somebody reads the approach and approves it before any code exists, which is the cheapest moment to redirect the work.