docs: restructure README into a getting-started page with docs sub-pages#336
Merged
Conversation
Slim the README down to an introduction (at a glance, real-world examples, architecture rules teaser) and move the reference content into dedicated documentation sub-pages for docs.testably.org: - 01-sources: the In/Types sources and navigation - 02-filters: the complete filter/assertion reference, string matching options and quantifiers (negation notes as admonitions) - 03-architecture-rules: type dependencies, dependency cycles and layers (caveats as admonitions) - 04-configuration: assembly exclusions, compiler-generated members and the dependency resolver - comparison/: the FluentAssertions comparison (moved, converted to synced tabs) and a new NetArchTest/ArchUnitNET comparison The NN- prefixes keep the sidebar order; URLs are unaffected by the renumbering since Docusaurus strips the prefix. The FluentAssertions comparison URL gains a /comparison/ segment.
b643645 to
0218bb3
Compare
🚀 Benchmark ResultsDetails
|
👽 Mutation ResultsaweXpect.ReflectionDetails
The final mutation score is NaN%Coverage Thresholds: high:80 low:60 break:0 |
|
|
This is addressed in release v2.0.0. |
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.
Slim the README down to an introduction (at a glance, real-world examples, architecture rules teaser) and move the reference content into dedicated documentation sub-pages for docs.testably.org:
The NN- prefixes keep the sidebar order; URLs are unaffected by the renumbering since Docusaurus strips the prefix. The FluentAssertions comparison URL gains a /comparison/ segment.