docs(plans): milestone 8 phase 2 - core documentation and README - #48
Conversation
Replace all 19 Getting Started/Concepts/How-to Guides skeleton pages with real content verified against the actual public API (Composer, CompositionBuilder, ICompositionProfile, ICompositionValueProvider, [Shared], [Compose]/[Compose<TProfile>]), and fix docs/index.md's and README.md's stale Compono.Create(...) example to the real Composer.Create(...) API. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
@codex review |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 66e1174a1c
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address PR #48 review feedback: the first tutorial's BeSameAs assertion required [Shared] on the repository parameter to actually pass (it wasn't marked), and The Composition Model page described IServiceProvider as a separate, later stage when it's the same exact-registration stage as Register<T> (docs/architecture.md's Resolution Pipeline, stage 3 vs 4). Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 48ce621df1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address further PR #48 review feedback: registrations-and-rules.md's Register<T> example registered the same IClock type twice in one snippet, which throws CompositionConfigurationException if copied verbatim; split into two either/or examples. composition-model.md's pipeline overview skipped stage 7 (built-in providers for primitives/enums/nullable/ collections), which is what actually satisfies Create<int>() or a generated List<T> member. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: ccad65a698
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address further PR #48 review feedback: - installation.md's verify-the-install smoke test used Create<int>(), satisfied by the built-in provider stage without ever exercising generated-plan dispatch; switched to a custom type. - first-test.md's tutorial uses AwesomeAssertions' .Should() without Installation telling readers to add that package; added it. - determinism-and-seeding.md claimed every composition failure's Message includes the seed; only true for Compono.XunitV3-thrown exceptions (WithSeedInMessage) — core Composer failures only have it via the nullable Diagnostic property. - composition-model.md's closing example implied Compono.Bogus configures a composed substitute's method return value; NSubstitute and Bogus are separate, non-interacting pipeline stages. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: c731878b57
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Address further PR #48 review feedback: installation.md's smoke check put a type declaration before top-level statements, which doesn't compile in C#; reordered. getting-started/index.md implied the source generator reads runtime Composer.Create(builder => ...) configuration directly, but the generator emits structural plans from type shapes at compile time and it's the plan's later runtime execution that consults configuration. Co-Authored-By: Claude Sonnet 5 <noreply@anthropic.com>
Summary
docs/index.md's andREADME.md's staleCompono.Create(builder => ...)example to the realComposer.Create(builder => ...)API.README.mdgets a new "Getting Started" section linking the docs site's Getting Started and AutoFixture migration guide (noCONTRIBUTING.mdlink yet — that's Phase 6's job).docs/documentation-architecture.md's Status lines for Getting Started/Concepts/How-to Guides from skeleton to real content.Every code snippet is verified against the actual public API (
Composer,CompositionBuilder,ICompositionProfile,ICompositionValueProvider,[Shared],[Compose]/[Compose<TProfile>]), cross-checked against real test files undertest/Compono.Tests/test/Compono.XunitV3.SampleTests.Test plan
uv run mkdocs build --clean --strictexits 0 — one dangling link this phase introduced (concepts/profiles.md→reference/api/index.md) was caught and fixed to the real generated landing page.mkdocs.ymlby Milestone 7 Phase 5.dotnet build/dotnet testrun.🤖 Generated with Claude Code