Rewrite the README and documentation in Simplified Technical English - #113
Merged
Merged
Conversation
The new text follows ASD-STE100 Issue 9. It was written from the source code, not from the previous documentation. All C# samples compile, and the samples that can run were run. A separate review checked each claim against the source. This removes the pages guide/scanning, guide/testing-registrations, reference/conventions-api, and reference/interfaces. It adds guide/testing-container-source and reference/api. The nine package descriptions are also rewritten. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
* Update the docs for the fixes to issues #63 to #94 The warnings and limits that described the defects are removed or corrected, and the pages now describe the behavior of PRs #95 to #111. DM0023, DM0024 and DM0025 get entries in the diagnostics reference. The package description of DependencyModules.SourceGenerator.Impl no longer tells the reader to add CSharpAuthor. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> * Describe Implementation decorators with generated factories, and retire DM0022 Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Ian Johnson <ianjohnson@mac.mynetworksettings.com> Co-authored-by: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
Keeps this branch's description of DependencyModules.SourceGenerator.Impl, which is in Simplified Technical English and already says that the package contains the CSharpAuthor sources, as #103 shipped them. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
A keyed factory method, TryEnumerable for a registration whose implementation is its service type, and a class with only internal constructors all fail at run time with no diagnostic. No issue tracks them yet. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
….Impl The merge of main took this branch's whole project file to keep its description, which dropped what #103 added: GeneratePathProperty on CSharpAuthor and the items that pack its sources. The project file now matches main except for the description. Co-Authored-By: Claude Opus 5.5 (1M context) <noreply@anthropic.com>
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
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.
This rewrites the README, the documentation site in
website/, and the nine package descriptions in ASD-STE100 Simplified Technical English, Issue 9. It also brings the pages up to date with the fixes for issues #63 to #94, which are all on main now.What is in the branch
guide/scanning,guide/testing-registrations,reference/conventions-apiandreference/interfaces. It addsguide/testing-container-sourceandreference/api..git-blame-ignore-revsat the CSharpier commit on main.DependencyModules.SourceGenerator.Impl. I kept this branch's version, which is in STE and already says that the package contains the CSharpAuthor sources.GeneratePathPropertyon CSharpAuthor and the items that pack its sources. The merge resolution in f6fd726 took this branch's whole file to keep the description, and dropped them. The first CI run failed in "Verify packages" because of it. The file now matches main except for the description.services.mdthat I found during the fixes. No issue tracks them. I reproduced each one on main at 3ce8021:Keyfails when the service is resolved. The keyed registration holds the method delegate as its instance.TryEnumerablethrowsArgumentExceptioninAddModulefor a class registered as itself and for every factory method.internalconstructors gets no diagnostic and fails at resolve, unless the module generates factories.Before you merge
docs.yamlpublisheswebsite/to GitHub Pages on a push to main.extending.mdsample referencesDependencyModules.SourceGenerator.Impl1.6.0. That assumes the next release is 1.6.0, because it adds diagnostics. A note covers 1.5.0 and earlier. Change the number if the release is different./guide/scanning,/guide/testing-registrations,/reference/conventions-apiand/reference/interfaces. A link to them from outside the site gets a 404.Verified
npm run buildinwebsite/passes, so no internal link is dead.dotnet csharpier check .is clean on the merged branch.scripts/verify-packages.sh. I also ran that script locally.🤖 Generated with Claude Code