Skip to content

Rewrite the README and documentation in Simplified Technical English - #113

Merged
ipjohnson merged 6 commits into
mainfrom
docs-ste-rewrite
Sep 24, 2026
Merged

ipjohnson merged 6 commits into
mainfrom
docs-ste-rewrite

Conversation

@ipjohnson

@ipjohnson ipjohnson commented Sep 24, 2026 •

Copy link
Copy Markdown
Owner

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

  • bca6986 is the rewrite. Its commit message says that the text was written from the source code, that all C# samples compile, and that a separate review checked each claim against the source. It removes guide/scanning, guide/testing-registrations, reference/conventions-api and reference/interfaces. It adds guide/testing-container-source and reference/api.
  • ce6372c points .git-blame-ignore-revs at the CSharpier commit on main.
  • Update the docs for the fixes to issues #63 to #94 #112 updates the pages for the fixes. It removes the warning for each fixed defect, adds DM0023, DM0024 and DM0025 to the diagnostics reference, and marks DM0022 as removed.
  • f6fd726 merges main. The only conflict was the description of DependencyModules.SourceGenerator.Impl. I kept this branch's version, which is in STE and already says that the package contains the CSharpAuthor sources.
  • c04bbdc restores what Ship the CSharpAuthor sources in DependencyModules.SourceGenerator.Impl #103 added to the Impl project file: GeneratePathProperty on 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.
  • 655e514 documents three limits in services.md that I found during the fixes. No issue tracks them. I reproduced each one on main at 3ce8021:
    • A factory method with Key fails when the service is resolved. The keyed registration holds the method delegate as its instance.
    • TryEnumerable throws ArgumentException in AddModule for a class registered as itself and for every factory method.
    • A class with only internal constructors gets no diagnostic and fails at resolve, unless the module generates factories.

Before you merge

  • Merging deploys the site. docs.yaml publishes website/ to GitHub Pages on a push to main.
  • The pages describe main, which is ahead of the 1.5.0 release: DM0023 to DM0025, DM0022 removed, and the fixed behavior. If the site should match the published packages, merge this with the next release.
  • The extending.md sample references DependencyModules.SourceGenerator.Impl 1.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.
  • These page URLs no longer exist: /guide/scanning, /guide/testing-registrations, /reference/conventions-api and /reference/interfaces. A link to them from outside the site gets a 404.

Verified

  • npm run build in website/ passes, so no internal link is dead.
  • dotnet csharpier check . is clean on the merged branch.
  • CI passes, including scripts/verify-packages.sh. I also ran that script locally.
  • No warning box remains in the pages.

🤖 Generated with Claude Code

Ian Johnson and others added 6 commits September 23, 2026 22:23
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>
79a2881 is not in the history of main. The squash merge of #62 made
d7a1a82, which is the reformat commit on main. With the old hash,
git blame still gave 53 lines of ModuleEnvironment.cs to the reformat.

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>
@ipjohnson
ipjohnson merged commit 242fa3f into main Sep 24, 2026
2 checks passed
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.

1 participant