Refresh provider-first docs and fix DocFX navbar#108
Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Refreshes the FastMoq v4 “provider-first” documentation set (including migration guidance) and updates the DocFX-generated Help/API outputs, adding a client-side recovery script to stabilize the DocFX navbar/header behavior and bumping the docs line to 4.3.0.
Changes:
- Updates site navigation and conceptual docs to emphasize provider-first patterns, including “tracked vs standalone” (
GetOrCreateMock<T>()vsCreateStandaloneFastMock<T>()/CreateFastMock<T>()) and related migration guidance. - Fixes DocFX header/navbar behavior by injecting
styles/fastmoq-docs.jsvia the DocFX template head partial. - Regenerates
Help/andapi/outputs and updates version references to4.3.0.
Reviewed changes
Copilot reviewed 232 out of 233 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| toc.yml | Adds “Provider capabilities” and introduces “Examples and Recipes” with a Cookbook entry in the DocFX TOC. |
| index.md | Updates the documentation landing page to 4.3.0 and adds provider-first guidance links (including Cookbook). |
| README.md | Updates the root README entry-point list to reflect preferred provider-first APIs (adds standalone vs tracked creation notes). |
| docs/README.md | Adds a direct link to the “Tracked vs standalone” section and bumps docs version line to 4.3.0. |
| docs/whats-new/README.md | Updates “What’s new” content/version to 4.3.0 and adds notes about tracked vs standalone guidance. |
| docs/getting-started/testing-guide.md | Adds sections clarifying tracked vs standalone fast mocks and documents MockModel equality semantics. |
| docs/migration/README.md | Adds migration guidance for using CreateStandaloneFastMock<T>() when needing an extra detached same-type double. |
| docs/migration/api-replacements-and-exceptions.md | Updates legacy API replacement table and examples to distinguish tracked vs standalone creation. |
| docs/samples/README.md | Updates samples overview to document tracked vs standalone mock usage patterns. |
| docs/samples/testing-examples.md | Adds an explicit “Tracked vs standalone” section and example snippet. |
| docs/api/quick-reference.md | Updates quick reference to point to Mocker for tracked/standalone creation APIs and adds MockModel equality note. |
| docs/api/index.md | Adds IFastMock<T> / MockModel<T> to quick lookup and clarifies tracked vs detached API location. |
| docfx-template/partials/head.tmpl.partial | Injects styles/fastmoq-docs.js into all generated pages to stabilize navbar/header behavior. |
| api/**.yml | Regenerated API reference YAML outputs. |
| Help/** | Regenerated published Help site HTML outputs (including TOC and pages) with the new script injected. |
Copilot stopped work on behalf of
cwinland due to an error
April 19, 2026 01:18
This was referenced Apr 19, 2026
Document provider-neutral verification for detached IFastMock handles and async-returning calls
#101
Closed
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
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
GetMock<T>()from the README common entry-point list so the main entry surface reflects the preferred APIsValidation
scripts/Generate-ApiDocs.ps1