docs: per-package READMEs + root README as family index#111
Merged
Conversation
…ily index
Each publishable Semantics package now ships its own README.md grounded in
its actual public API (Strings, Strings.Identifiers, Paths, Quantities,
Quantities.{Double,Float,Decimal}, Music, Color). The root README becomes a
family overview with a package index table and short per-pillar teasers that
link to each package README for full detail.
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.
Summary
Each publishable
Semanticspackage now ships its ownREADME.md, and the root README becomes a family overview that points to them for full detail.Per-package READMEs (9)
Grounded in each package's actual public API (types, factories, and members verified against source):
ktsu.Semantics.Strings—SemanticString<T>, factory/DI, validation-attribute cataloguektsu.Semantics.Strings.Identifiers— the six identifier types with normalization/validation and documented limitsktsu.Semantics.Paths— interface hierarchy, concrete types,/composition,AsAbsolute/AsRelativektsu.Semantics.Quantities— unified vector model, generatedFrom{Unit}factories,PhysicalConstantsktsu.Semantics.Quantities.{Double,Float,Decimal}— props-only alias mechanism and the one-per-project rulektsu.Semantics.Music— value types, chord parsing/voicing, roman numerals, analysis layerktsu.Semantics.Color— linear/sRGB model, color spaces, WCAG accessibility toolingStandard 7-badge block per package: GitHub badges point at the shared
ktsu-dev/Semanticsrepo, NuGet badges at the specific package ID, relative links (../LICENSE.md,../README.md,../docs/...) back to the repo root. The ktsu SDK packs a project-level README when present, so each package now ships its own on NuGet instead of the fallback root README.Root README
Now a landing page: a Packages index table linking to all nine per-package READMEs,
Semantics.Coloradded as a fifth pillar, and each pillar trimmed to a short teaser + snippet ending in a link to its package README.Notes
Semantics.SourceGeneratorshas no README (build-time only,IsPackable=false, never published).🤖 Generated with Claude Code