Repository navigation
docs: correct the docs for the 0.4.0 release - #82
Merged
Merged
Conversation
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.
Contributor
There was a problem hiding this comment.
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.
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.
Docs-only fixes for the 0.4.0 release, checked against the source at
3810f00(Program.cs,ComponentManager,ComponentInstaller,DoctorService,MigrateService,ComponentRegistry.csand the template metadata,ShellUIConfig,CssTemplates, the.csprojfiles). No code, version orrelease/v0.3changes.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.mddoctorormigrate; added both.listsaid "the 93 components"; it lists 98 (components and layout blocks).updaterow said--allis needed for every component; with no names it already updates all of them.updateoverwrites your copies; it skips files changed since the CLI wrote them unless--force.removedoesn't handle dashboard layouts; it deletes the file fromComponents/Layout/and lists files that still use it.add all/--exceptand themigrateoptions.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", now0.4.0.README.md: command reference table had nodoctor/migrate;updaterow didn't mention that changed files are skipped;addrow now mentionsall.docs/QUICKSTART.md: "93 direct targets" → 98; theinput.cssexcerpt showed--primary: oklch(0.55 0.22 264.53), butinitwritesoklch(0 0 0)(andcolor-scheme: light;first).docs/CLI_SYNTAX.md: saidupdate"still overwrites the file"; it compares against the recordedHashand skips changed files unless--force. AddedHash(an illustrative 64-char hex value) to theshellui.jsonsample.docs/FAQ.md: "93 direct targets" (twice) → 98; sameupdate overwritesclaim fixed;Hashadded to the sample; "Pass the version explicitly" was followed by a command with no version (now: re-run without--versionfor the latest stable).docs/PROJECT_STATUS.md: 243/93/150 → 254/98/156; command list had nodoctor/migrate; dropped--prereleasefrom the pinned-versiondotnet add packageexample.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 ofshellui-jsusers was missingresizable(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 nodoctor/migrate; option list forinit/addwas missing--dashboard,--replace-layout,--except; said layout blocks must be removed manually; added the file hash to whataddrecords.docs/CONTRIBUTING.md: "active alpha project" / "Alpha software" → pre-1.0; command list had nodoctor/migrate; 243/93/150 → 254/98/156; framework line now mentions net9.0 forShellUI.Components.docs/tailwind-setup.md: prerequisite said ".NET 10.0 SDK" → ".NET 8 SDK or later"; saidinitdownloads Tailwind into the project's.shellui/bin(it's the per-machine~/.shellui/bin); command list had nodoctor/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.1was the last release targeting .NET 9" now says 0.4.0 supports .NET 8, 9 and 10 again (verified per tag); dropped--prereleasefrom the pinned-version example;Hashadded to the sample.docs/RELEASING.md: the "Cutting a release" walkthrough used0.4.0-alpha.3; it now walks through the stable0.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.0section (claims match the source; compare link isv0.3.6...v0.4.0),docs/razor-class-library.md(matchesInitService.RazorClassLibraryHostSteps).Verification
bash scripts/extract-release-notes.sh 0.4.0: exit 0, 61 lines, from# ShellUI v0.4.0to 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 usedotnet-version: 10.0.x. That works, but .NET 8 would work too; left unchanged.