Skip to content

Docs: Step Builder Design Doc + ROADMAP/AGENTS/CHANGELOG - #295

Merged
Skymly merged 1 commit into
mainfrom
feature/291-step-builder-design-doc
Aug 3, 2026
Merged

Docs: Step Builder Design Doc + ROADMAP/AGENTS/CHANGELOG#295
Skymly merged 1 commit into
mainfrom
feature/291-step-builder-design-doc

Conversation

@Skymly

@Skymly Skymly commented Aug 3, 2026

Copy link
Copy Markdown
Owner

Summary

  • Add docs/design/StepBuilder.md covering attributes, generated {Holder}Builder type-state proof model, DP078–DP086, non-goals, and comparison vs registration/assembly *Builder types
  • Record ADR-010 (generic type-state markers + required-step cap 8) and index it from the design doc / ADR README
  • Update ROADMAP F3 Top-2 Builder status to shipped MVP [~], AGENTS pattern summary, and CHANGELOG [Unreleased]

Related Issue

Closes #291

Solution module

  • Docs / Repository (README, docs/, .github/, AGENTS.md, build/)

Type of change

  • Docs / repo metadata only

Test plan

  • ./build.ps1 --target Ci --configuration Release
  • Sibling samples (N/A — docs only)

Breaking changes

  • None

Checklist

  • This PR touches only one solution module (see AGENTS.md)
  • Commit messages are in English
  • PR description is English only
  • No version bumps, tags, releases, or NuGet publish steps included unless explicitly requested
  • Public API / diagnostic / generated code changes are documented if user-visible

Documentation checklist

  • Design Doc updated if API / diagnostic / implementation changed
  • User-facing docs synced (separate PRs if multi-repo)
  • No documentation changes needed

Note

Low Risk
Documentation and repository metadata only; no product code, APIs, or diagnostics behavior changes.

Overview
Documents the Step Builder domain for maintainers: new docs/design/StepBuilder.md covers [GenerateBuilder] / [BuilderStep] / [BuilderAssemble], the generated {Holder}Builder type-state model, DP078–DP086, MVP non-goals, and how Step Builder differs from registration-style *Builder types.

Adds ADR-010 (generic type-state for required-step completeness, cap of 8 required steps) and wires it into the design and ADR indexes. AGENTS.md, docs/ROADMAP.md (F3 Top-2 Builder → MVP [~], naming table), and CHANGELOG.md [Unreleased] are updated to match; no runtime, generator, or diagnostic code changes in this PR.

Reviewed by Cursor Bugbot for commit 29e1f8b. Configure here.

Record the shipped GenerateBuilder surface for maintainers and link Spec #287 so ROADMAP/AGENTS stay aligned with the generator work.

Co-authored-by: Cursor <cursoragent@cursor.com>
@Skymly
Skymly merged commit b38e724 into main Aug 3, 2026
4 checks passed
@Skymly
Skymly deleted the feature/291-step-builder-design-doc branch August 3, 2026 11:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Step Builder Design Doc + ROADMAP/AGENTS/CHANGELOG

1 participant