Skip to content

docs: correct the docs for the 0.4.0 release - #82

Merged
Shewart merged 4 commits into
mainfrom
docs/release-0.4.0-fixes
Oct 30, 2026
Merged

Shewart merged 4 commits into
mainfrom
docs/release-0.4.0-fixes

Conversation

@Shewart

@Shewart Shewart commented Oct 30, 2026

Copy link
Copy Markdown
Contributor

Docs-only fixes for the 0.4.0 release, checked against the source at 3810f00 (Program.cs, ComponentManager, ComponentInstaller, DoctorService, MigrateService, ComponentRegistry.cs and the template metadata, ShellUIConfig, CssTemplates, the .csproj files). No code, version or release/v0.3 changes.

Registry facts used: 254 entries = 98 direct targets (IsAvailable = true) + 156 hidden; per-category counts and the direct-target dependency table were regenerated from the template metadata and match.

Packaged README (ships in the nupkg)

  • src/ShellUI.CLI/README.md
    • Command table had no doctor or migrate; added both.
    • list said "the 93 components"; it lists 98 (components and layout blocks).
    • update row said --all is needed for every component; with no names it already updates all of them.
    • Said update overwrites your copies; it skips files changed since the CLI wrote them unless --force.
    • Said remove doesn't handle dashboard layouts; it deletes the file from Components/Layout/ and lists files that still use it.
    • Added add all / --except and the migrate options.
  • src/ShellUI.Components/README.md: checked (asset names, ButtonVariant.Outline, .NET 8/9/10), no changes needed.

Repo docs

  • docs/CLI_INSTALLATION.md: local tool manifest example showed "version": "0.3.5", now 0.4.0.
  • README.md: command reference table had no doctor / migrate; update row didn't mention that changed files are skipped; add row now mentions all.
  • docs/QUICKSTART.md: "93 direct targets" → 98; the input.css excerpt showed --primary: oklch(0.55 0.22 264.53), but init writes oklch(0 0 0) (and color-scheme: light; first).
  • docs/CLI_SYNTAX.md: said update "still overwrites the file"; it compares against the recorded Hash and skips changed files unless --force. Added Hash (an illustrative 64-char hex value) to the shellui.json sample.
  • docs/FAQ.md: "93 direct targets" (twice) → 98; same update overwrites claim fixed; Hash added to the sample; "Pass the version explicitly" was followed by a command with no version (now: re-run without --version for the latest stable).
  • docs/PROJECT_STATUS.md: 243/93/150 → 254/98/156; command list had no doctor / migrate; dropped --prerelease from the pinned-version dotnet add package example.
  • docs/COMPONENT_ROADMAP.md: header said ".NET 10" → ".NET 8, 9 and 10"; 243/93/150 → 254/98/156; the "Compositional upgrades (done)" list was missing the 0.4 parts for AlertDialog, Breadcrumb, Command, Form, Menubar, Pagination and Resizable.
  • docs/COMPONENT_DEPENDENCIES.md: list of shellui-js users was missing resizable (table itself matched the metadata).
  • docs/COMPARISON.md: "Current project is an alpha snapshot" → "Pre-1.0 project".
  • docs/ARCHITECTURE.md: command table (which says commands not listed aren't part of the CLI) had no doctor / migrate; option list for init/add was missing --dashboard, --replace-layout, --except; said layout blocks must be removed manually; added the file hash to what add records.
  • docs/CONTRIBUTING.md: "active alpha project" / "Alpha software" → pre-1.0; command list had no doctor / migrate; 243/93/150 → 254/98/156; framework line now mentions net9.0 for ShellUI.Components.
  • docs/tailwind-setup.md: prerequisite said ".NET 10.0 SDK" → ".NET 8 SDK or later"; said init downloads Tailwind into the project's .shellui/bin (it's the per-machine ~/.shellui/bin); command list had no doctor / migrate; init options now include --dashboard / --replace-layout.
  • VERSIONING_STRATEGY.md: "the current repository baseline is .NET 10" and the summary "targeting .NET 10" were wrong for 0.4.0; "0.3.0-rc.1 was the last release targeting .NET 9" now says 0.4.0 supports .NET 8, 9 and 10 again (verified per tag); dropped --prerelease from the pinned-version example; Hash added to the sample.
  • docs/RELEASING.md: the "Cutting a release" walkthrough used 0.4.0-alpha.3; it now walks through the stable 0.4.0 (empty suffix, prepare-release.ps1 -Version 0.4.0 -DryRun, git tag v0.4.0), with a note on the suffix for prereleases.

Checked and left as is: docs/RELEASE_NOTES.md # ShellUI v0.4.0 section (claims match the source; compare link is v0.3.6...v0.4.0), docs/razor-class-library.md (matches InitService.RazorClassLibraryHostSteps).

Verification

  • bash scripts/extract-release-notes.sh 0.4.0: exit 0, 61 lines, from # ShellUI v0.4.0 to the Full Changelog line.
  • dotnet build ShellUI.slnx -c Release: 0 warnings, 0 errors.
  • dotnet test ShellUI.slnx -c Release: 542 passed, 0 failed on net8.0 and on net10.0.

Unsure / for review

  • docs/CLI_INSTALLATION.md's CI examples use dotnet-version: 10.0.x. That works, but .NET 8 would work too; left unchanged.

List doctor and migrate, count the 98 list targets, describe add all
and --except, and say that update skips files you changed and that
remove handles layout blocks.
Registry counts are 254/98/156, doctor and migrate are listed wherever
the command surface is, update is described as skipping changed files
(Hash in shellui.json), and the framework lines say .NET 8, 9 and 10.
The shellui.json samples show a 64-character lowercase hex Hash like the
CLI writes, and RELEASING's steps use the stable 0.4.0 release, with a
note on the suffix for prereleases.
Copilot AI balanced review requested due to automatic review settings October 30, 2026 12:58

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has insufficient remaining quota.

An organization owner can choose the repository organization as the billing source for reviews requested by members with a paid Copilot license. Learn about Copilot code review billing.

@Shewart
Shewart merged commit bdfa8e5 into main Oct 30, 2026
1 check passed
@Shewart
Shewart deleted the docs/release-0.4.0-fixes branch October 30, 2026 13:01
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.

2 participants