docs: simplify order and structure of documentation#433
Conversation
There was a problem hiding this comment.
Pull request overview
This PR reorganizes the documentation structure to improve readability and consistency by adjusting heading levels and reordering sections for better flow.
Changes:
- Converted several subsection headings from H3/H4/H5 (###/####/#####) to bold text for better visual hierarchy
- Moved the "Methods" section after "Properties" in verification documentation for consistent ordering
- Extracted "Check for unexpected interactions" content into a separate advanced features document
- Relocated "Argument Matchers" section to appear after all verification examples
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| README.md | Changed heading levels to bold text, reordered Methods/Properties sections, moved "Check for unexpected interactions" to Advanced Features, and relocated "Argument Matchers" section |
| Mockolate.slnx | Added reference to new documentation file for unexpected interactions |
| Docs/pages/setup/04-parameter-matching.md | Converted subsection headings from H3 (###) to bold text formatting |
| Docs/pages/advanced-features/03-check-for-unexpected-interactions.md | New file containing extracted content about checking for unexpected interactions |
| Docs/pages/advanced-features/01-working-with-protected-members.md | Changed heading structure from H2/H3 (##/###) to bold/H2 for Example/Setup/Verification sections |
| Docs/pages/04-verify-interactions.md | Reordered Methods and Properties sections, moved Argument Matchers after examples, removed "Check for unexpected interactions" content |
| Docs/pages/01-create-mocks.md | Converted H3 heading (###) to bold text for MockBehavior options |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
|
🚀 Benchmark ResultsDetails
|
|
This is addressed in release v1.1.0. |



This PR reorganizes the documentation structure to improve readability and consistency by adjusting heading levels and reordering sections for better flow.
Key Changes: