Repository navigation
Reorder and complete the documentation - #12
Merged
Merged
Conversation
tools/docs-check.sh lists every property, item and MSKIT_ code the kit defines or reads, requires a row for each in docs/reference/, rejects names and codes the kit does not have, and resolves relative links and their anchors.
docs-check accepts MSKIT_VER006 and MSKITVER006 as one code and wants each code's section in docs/reference/codes.md headed by the id without the underscore, so its anchor survives the planned code rename. The README keeps the key features, install and links; the detail moves to docs/.
Content moved out of the README and checked against the kit: the update rewrites more than .toolkit/msbuild/, any tag build is a release build, the TFM constants start at net7.0 and include net48 and netstandard, and the owner layer's NoWarn and unconditional values are named.
Packaging separates the settings every project gets from the metadata packable projects get, and names the symbol, release-notes and readme fallbacks the README left out. Code links point at the code reference anchors.
Roslyn states that a component imports its role's props itself; the name only sets the role. Testing lists every detected name and the versions the kit provides; customizing names the owner layer's unconditional values and the extension files.
…lf-test docs/reference/properties.md lists every property and item the kit sets or reads; docs/reference/codes.md has one section per code, anchored by the id without the underscore. tests/docs.sh runs tools/docs-check.sh on the tree, proves it reports a broken copy, and that a code spelled without the underscore still matches.
# Conflicts: # CHANGELOG.md # CONTRIBUTING.md
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
1 participant
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 — no kit behaviour changes.
#mskitver006so the planned code rename keeps its links).tools/docs-check.sh, run bytests/run.sh: fails on a property, item or code without its reference entry, a name the kit lacks, or a broken link/anchor; the self-test proves it fires on a broken copy and accepts the underscore-less code spelling..toolkit/msbuild/; any tag build is a release build; TFM constants start at net7.0 and include net48/netstandard; symbols, release-notes and test-name details.Audit
Before: 110 of 157 properties and 32 of 58 codes were undocumented; 9 wrong or misleading claims. Kit defects found while reading (not changed):
MSKit_CopySecretsToProjectreplaces the project's.gitignore; the Roslyn errors suggest a csproj opt-out that runs too late;MSKit_Diagnostic/DisableSharedGlobalUsingsare never read; EF scripts update the globaldotnet-ef.