Improve documentation pipeline guides#123
Draft
Reefact wants to merge 10 commits into
Draft
Conversation
Fix claims that contradicted the implementation: - add the mandatory diagnostics stage to the DescribeError examples in the architecture and internationalization guides (WithRule returns the diagnostics stage, which has no WithExamples); - add --service-name to every markdown generate example (the CLI exits with an error for markdown/html without a service name); - repeat --assemblies per path instead of passing two paths to one flag; - state that the build runs on the whole solution before project discovery and opt-in selection, not on selected projects afterwards; - distinguish extraction failures returned by a completed worker (always logged, generation continues) from process-level failures (the only ones that honor the configured failure policy); - pass the required service name in the programmatic rendering example (the two-argument RenderRequest leaves ServiceName null and the markdown renderer throws ServiceNameRequiredException); - document the RenderRequest.ServiceName property and the actual namespace split between the renderer contract and the documentation model. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LUaMS5EHzAdQHBJzrYvKTj
Apply the same corrections as the English pipeline guides and restore content the French pages had trimmed against the canonical English: - the standalone --no-build example and the safe CI sequence framing; - the closing guidance sentence of the timeouts section; - the six-bullet avoid list for documentation factories, including the time-and-randomness item; - the configuration alignment lead-in and the literal opt-in marker in the troubleshooting checklist; - the lead-in sentences and the split relative-paths/deterministic-order items of the renderer design checklist. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01LUaMS5EHzAdQHBJzrYvKTj
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR separates the documentation pipeline's architectural model from its project-discovery and extraction reference, then aligns the custom-renderer and internationalization guides with those clearer boundaries.
Type of change
Changes
Testing
dotnet build FirstClassErrors.slndotnet test FirstClassErrors.slnFirstClassErrors.Analyzers.UnitTests)No build or test command was run because this PR changes Markdown documentation only. The documented behavior was reviewed against the existing pipeline, renderer, CLI, and internationalization contracts, and the branch diff and cross-page navigation were reviewed manually.
Documentation
doc/updateddoc/README.fr.md) updated if user-facing behavior changedThe French counterpart of every changed or added English page is included.
doc/README.fr.mditself did not require a change because the existing architecture, renderer, and internationalization entries remain valid entry points and now link to the focused extraction reference.Related issues
None.