Skip to content

Comments

docs: simplify order and structure of documentation#433

Merged
vbreuss merged 2 commits intomainfrom
topic/refactor-docs
Jan 31, 2026
Merged

docs: simplify order and structure of documentation#433
vbreuss merged 2 commits intomainfrom
topic/refactor-docs

Conversation

@vbreuss
Copy link
Contributor

@vbreuss vbreuss commented Jan 31, 2026

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

Key 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

@vbreuss vbreuss self-assigned this Jan 31, 2026
Copilot AI review requested due to automatic review settings January 31, 2026 07:38
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 31, 2026
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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>
Copilot AI review requested due to automatic review settings January 31, 2026 07:40
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 7 out of 7 changed files in this pull request and generated no new comments.

@vbreuss vbreuss merged commit 182ec01 into main Jan 31, 2026
8 checks passed
@vbreuss vbreuss deleted the topic/refactor-docs branch January 31, 2026 07:42
@sonarqubecloud
Copy link

@github-actions
Copy link

github-actions bot commented Jan 31, 2026

🚀 Benchmark Results

Details

BenchmarkDotNet v0.15.8, Linux Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763 2.82GHz, 1 CPU, 4 logical and 2 physical cores
.NET SDK 10.0.102
[Host] : .NET 10.0.2 (10.0.2, 10.0.225.61305), X64 RyuJIT x86-64-v3

Job=InProcess Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=1 WarmupCount=10

Method Mean Error StdDev Gen0 Gen1 Allocated
Simple_Mockolate 1.501 μs 0.0107 μs 0.0095 μs 0.2270 - 3.73 KB
Simple_Moq 179.987 μs 0.9702 μs 0.8101 μs 0.4883 - 14.55 KB
Simple_NSubstitute 5.710 μs 0.0643 μs 0.0601 μs 0.5569 0.0076 9.14 KB
Simple_FakeItEasy 6.265 μs 0.0227 μs 0.0212 μs 0.4959 - 8.11 KB

@github-actions
Copy link

This is addressed in release v1.1.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant