Skip to content

Commit 42db7cd

Browse files
committed
Doc rewrites
1 parent dd5009f commit 42db7cd

8 files changed

Lines changed: 135 additions & 135 deletions

File tree

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ If you want a copy-paste example that works under the default provider without M
124124
- **🧪 [Testing Guide](./docs/getting-started/testing-guide.md)** - Repo-native guidance for `GetOrCreateMock<T>()`, `AddType(...)`, `DbContext`, `IFileSystem`, and known types
125125
- **🔄 [Migration Guide](./docs/migration)** - Practical old-to-new guidance for the `3.0.0` to `4.3.0` transition
126126
- **👨‍🍳 [Cookbook](./docs/cookbook)** - Real-world patterns and recipes with compatibility-only pockets labeled explicitly
127-
- **🔎 [API Reference Overview](./docs/api/index.md)** - Example-first API entry points plus quick routes into the generated reference
127+
- **🔎 [API Reference](https://help.fastmoq.com/)** - Published HTML API reference for namespaces, types, and members
128128
- **🌐 [Web Helper Guidance](./docs/getting-started/testing-guide.md#controller-testing)** - Controller, `HttpContext`, `IHttpContextAccessor`, and claims-principal test setup
129129
- **🔌 [Provider Selection Guide](./docs/getting-started/provider-selection.md)** - How to register, select, and bootstrap providers for a test assembly
130130
- **📋 [Provider Capabilities](./docs/getting-started/provider-capabilities.md)** - What `moq`, `nsubstitute`, and `reflection` support today, with recommended usage patterns

docs/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ Practical guidance for moving from the public `3.0.0` release toward the current
5353

5454
### 🔎 [API Reference](./api/index.md)
5555

56-
Use the docs-side API overview when you want example-first entry points before dropping into the generated YAML pages.
56+
Use the docs-side API overview when you want example-first entry points and curated type routes. Use [Complete API Documentation](https://help.fastmoq.com/) when you want the full published namespace, type, and member reference.
5757

5858
- Example-first API routes
5959
- Quick reference for common types

docs/api/index.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# FastMoq API Reference
22

3-
This API reference is generated from XML comments in the source projects.
3+
The published API reference is generated from XML comments in the source projects.
44

55
## Example-first entry points
66

@@ -13,18 +13,18 @@ This API reference is generated from XML comments in the source projects.
1313
## Quick type lookup
1414

1515
- [Quick reference for common types](./quick-reference.md)
16-
- [Mocker](../../api/FastMoq.Mocker.yml)
17-
- [MockerTestBase&lt;TComponent&gt;](../../api/FastMoq.MockerTestBase-1.yml)
18-
- [ScenarioBuilder&lt;T&gt;](../../api/FastMoq.ScenarioBuilder-1.yml)
19-
- [IFastMock&lt;T&gt;](../../api/FastMoq.Providers.IFastMock-1.yml)
20-
- [MockModel&lt;T&gt;](../../api/FastMoq.Models.MockModel-1.yml)
21-
- [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml)
22-
- [FunctionContextTestExtensions](../../api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.yml)
23-
- [TestWebExtensions](../../api/FastMoq.Web.Extensions.TestWebExtensions.yml)
16+
- [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
17+
- [MockerTestBase&lt;TComponent&gt;](https://help.fastmoq.com/api/FastMoq.MockerTestBase-1.html)
18+
- [ScenarioBuilder&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.ScenarioBuilder-1.html)
19+
- [IFastMock&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Providers.IFastMock-1.html)
20+
- [MockModel&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Models.MockModel-1.html)
21+
- [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html)
22+
- [FunctionContextTestExtensions](https://help.fastmoq.com/api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.html)
23+
- [TestWebExtensions](https://help.fastmoq.com/api/FastMoq.Web.Extensions.TestWebExtensions.html)
2424

2525
If you are integrating a non-bundled mocking library, start from [Quick reference for common types](./quick-reference.md) and follow the provider path through `IMockingProvider`, `IMockingProviderCapabilities`, and `MockingProviderRegistry`.
2626

27-
Lifecycle note: tracked creation helpers such as `GetOrCreateMock<T>()` and `CreateFastMock<T>()`, plus detached creation through `CreateStandaloneFastMock<T>()`, are methods on [Mocker](../../api/FastMoq.Mocker.yml) rather than separate API types.
27+
Lifecycle note: tracked creation helpers such as `GetOrCreateMock<T>()` and `CreateFastMock<T>()`, plus detached creation through `CreateStandaloneFastMock<T>()`, are methods on [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html) rather than separate API types.
2828

2929
## Notes
3030

docs/api/quick-reference.md

Lines changed: 53 additions & 53 deletions
Original file line numberDiff line numberDiff line change
@@ -4,101 +4,101 @@ Use this page when you already know the type name and want to jump straight to t
44

55
## Most-used starting points
66

7-
- [Mocker](../../api/FastMoq.Mocker.yml)
8-
- [MockerTestBase&lt;TComponent&gt;](../../api/FastMoq.MockerTestBase-1.yml)
9-
- [ScenarioBuilder&lt;T&gt;](../../api/FastMoq.ScenarioBuilder-1.yml)
10-
- [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml)
11-
- [MockerBlazorTestBase&lt;T&gt;](../../api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.yml)
7+
- [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
8+
- [MockerTestBase&lt;TComponent&gt;](https://help.fastmoq.com/api/FastMoq.MockerTestBase-1.html)
9+
- [ScenarioBuilder&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.ScenarioBuilder-1.html)
10+
- [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html)
11+
- [MockerBlazorTestBase&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.html)
1212

1313
## Core test entry points
1414

15-
- [Mocker](../../api/FastMoq.Mocker.yml)
16-
- [MockerTestBase&lt;TComponent&gt;](../../api/FastMoq.MockerTestBase-1.yml)
17-
- [ScenarioBuilder&lt;T&gt;](../../api/FastMoq.ScenarioBuilder-1.yml)
15+
- [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
16+
- [MockerTestBase&lt;TComponent&gt;](https://help.fastmoq.com/api/FastMoq.MockerTestBase-1.html)
17+
- [ScenarioBuilder&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.ScenarioBuilder-1.html)
1818

1919
## Arrange and creation
2020

21-
- [Mocker](../../api/FastMoq.Mocker.yml)
22-
- [IFastMock&lt;T&gt;](../../api/FastMoq.Providers.IFastMock-1.yml)
23-
- [KnownTypeRegistration](../../api/FastMoq.KnownTypeRegistration.yml)
24-
- [InstanceCreationFlags](../../api/FastMoq.InstanceCreationFlags.yml)
25-
- [InvocationOptions](../../api/FastMoq.InvocationOptions.yml)
21+
- [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
22+
- [IFastMock&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Providers.IFastMock-1.html)
23+
- [KnownTypeRegistration](https://help.fastmoq.com/api/FastMoq.KnownTypeRegistration.html)
24+
- [InstanceCreationFlags](https://help.fastmoq.com/api/FastMoq.InstanceCreationFlags.html)
25+
- [InvocationOptions](https://help.fastmoq.com/api/FastMoq.InvocationOptions.html)
2626

27-
Use the [Mocker](../../api/FastMoq.Mocker.yml) page for the tracked and standalone creation APIs: `GetOrCreateMock<T>()`, `CreateFastMock<T>()`, and `CreateStandaloneFastMock<T>()`.
27+
Use the [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html) page for the tracked and standalone creation APIs: `GetOrCreateMock<T>()`, `CreateFastMock<T>()`, and `CreateStandaloneFastMock<T>()`.
2828

2929
## Provider APIs
3030

31-
- [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml)
32-
- [IMockingProvider](../../api/FastMoq.Providers.IMockingProvider.yml)
33-
- [IMockingProviderCapabilities](../../api/FastMoq.Providers.IMockingProviderCapabilities.yml)
34-
- [TimesSpec](../../api/FastMoq.Providers.TimesSpec.yml)
35-
- [MockCreationOptions](../../api/FastMoq.Providers.MockCreationOptions.yml)
31+
- [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html)
32+
- [IMockingProvider](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProvider.html)
33+
- [IMockingProviderCapabilities](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProviderCapabilities.html)
34+
- [TimesSpec](https://help.fastmoq.com/api/FastMoq.Providers.TimesSpec.html)
35+
- [MockCreationOptions](https://help.fastmoq.com/api/FastMoq.Providers.MockCreationOptions.html)
3636

37-
If you are writing your own provider instead of using the bundled ones, start with [IMockingProvider](../../api/FastMoq.Providers.IMockingProvider.yml), then [IMockingProviderCapabilities](../../api/FastMoq.Providers.IMockingProviderCapabilities.yml), then [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml).
37+
If you are writing your own provider instead of using the bundled ones, start with [IMockingProvider](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProvider.html), then [IMockingProviderCapabilities](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProviderCapabilities.html), then [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html).
3838

39-
Detached provider-first creation and verification also live on [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml): use `CreateMock<T>()`, `Verify(...)`, and `VerifyNoOtherCalls(...)` there when the `IFastMock<T>` handle is not tracked inside a `Mocker`.
39+
Detached provider-first creation and verification also live on [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html): use `CreateMock<T>()`, `Verify(...)`, and `VerifyNoOtherCalls(...)` there when the `IFastMock<T>` handle is not tracked inside a `Mocker`.
4040

4141
Reflection-provider reminder: its verification is best-effort and only compares direct constant arguments with `Equals(...)`; it is not equivalent to richer provider-native matcher semantics.
4242

4343
## Logging and verification
4444

45-
- [TestClassExtensions](../../api/FastMoq.Extensions.TestClassExtensions.yml)
46-
- [TimesSpec](../../api/FastMoq.Providers.TimesSpec.yml)
47-
- [MockBehaviorOptions](../../api/FastMoq.MockBehaviorOptions.yml)
48-
- [MockFeatures](../../api/FastMoq.MockFeatures.yml)
45+
- [TestClassExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.TestClassExtensions.html)
46+
- [TimesSpec](https://help.fastmoq.com/api/FastMoq.Providers.TimesSpec.html)
47+
- [MockBehaviorOptions](https://help.fastmoq.com/api/FastMoq.MockBehaviorOptions.html)
48+
- [MockFeatures](https://help.fastmoq.com/api/FastMoq.MockFeatures.html)
4949

5050
## Extension helpers
5151

52-
- [MockerCreationExtensions](../../api/FastMoq.Extensions.MockerCreationExtensions.yml)
53-
- [TestClassExtensions](../../api/FastMoq.Extensions.TestClassExtensions.yml)
54-
- [MockerHttpExtensions](../../api/FastMoq.Extensions.MockerHttpExtensions.yml)
55-
- [MockerBooleanExtensions](../../api/FastMoq.Extensions.MockerBooleanExtensions.yml)
56-
- [ObjectExtensions](../../api/FastMoq.Extensions.ObjectExtensions.yml)
52+
- [MockerCreationExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.MockerCreationExtensions.html)
53+
- [TestClassExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.TestClassExtensions.html)
54+
- [MockerHttpExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.MockerHttpExtensions.html)
55+
- [MockerBooleanExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.MockerBooleanExtensions.html)
56+
- [ObjectExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.ObjectExtensions.html)
5757

5858
## Framework helpers
5959

60-
- [FunctionContextTestExtensions](../../api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.yml)
61-
- [TestWebExtensions](../../api/FastMoq.Web.Extensions.TestWebExtensions.yml)
60+
- [FunctionContextTestExtensions](https://help.fastmoq.com/api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.html)
61+
- [TestWebExtensions](https://help.fastmoq.com/api/FastMoq.Web.Extensions.TestWebExtensions.html)
6262

6363
## Database helpers
6464

65-
- [DbContextMockerExtensions](../../api/FastMoq.DbContextMockerExtensions.yml)
66-
- [DbContextHandle&lt;TContext&gt;](../../api/FastMoq.DbContextHandle-1.yml)
67-
- [DbContextHandleOptions&lt;TContext&gt;](../../api/FastMoq.DbContextHandleOptions-1.yml)
68-
- [DbContextTestMode](../../api/FastMoq.DbContextTestMode.yml)
65+
- [DbContextMockerExtensions](https://help.fastmoq.com/api/FastMoq.DbContextMockerExtensions.html)
66+
- [DbContextHandle&lt;TContext&gt;](https://help.fastmoq.com/api/FastMoq.DbContextHandle-1.html)
67+
- [DbContextHandleOptions&lt;TContext&gt;](https://help.fastmoq.com/api/FastMoq.DbContextHandleOptions-1.html)
68+
- [DbContextTestMode](https://help.fastmoq.com/api/FastMoq.DbContextTestMode.html)
6969

7070
## Common models and helper types
7171

72-
- [LogEntry](../../api/FastMoq.Models.LogEntry.yml)
73-
- [MockModel&lt;T&gt;](../../api/FastMoq.Models.MockModel-1.yml)
74-
- [InstanceModel&lt;TClass&gt;](../../api/FastMoq.Models.InstanceModel-1.yml)
75-
- [ConstructorHistory](../../api/FastMoq.Models.ConstructorHistory.yml)
72+
- [LogEntry](https://help.fastmoq.com/api/FastMoq.Models.LogEntry.html)
73+
- [MockModel&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Models.MockModel-1.html)
74+
- [InstanceModel&lt;TClass&gt;](https://help.fastmoq.com/api/FastMoq.Models.InstanceModel-1.html)
75+
- [ConstructorHistory](https://help.fastmoq.com/api/FastMoq.Models.ConstructorHistory.html)
7676

7777
## Tracked models and provider escape hatches
7878

79-
- [IFastMock&lt;T&gt;](../../api/FastMoq.Providers.IFastMock-1.yml)
80-
- [MockModel&lt;T&gt;](../../api/FastMoq.Models.MockModel-1.yml)
81-
- [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml)
79+
- [IFastMock&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Providers.IFastMock-1.html)
80+
- [MockModel&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Models.MockModel-1.html)
81+
- [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html)
8282

8383
`MockModel` equality is type-based, not instance-based. Use it to reason about mocked service types, not to decide whether two provider-native doubles are the same object.
8484

8585
## Blazor and web
8686

87-
- [MockerBlazorTestBase&lt;T&gt;](../../api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.yml)
88-
- [IMockerBlazorTestHelpers&lt;T&gt;](../../api/FastMoq.Web.Blazor.Interfaces.IMockerBlazorTestHelpers-1.yml)
89-
- [ComponentState&lt;T&gt;](../../api/FastMoq.Web.Blazor.Models.ComponentState-1.yml)
87+
- [MockerBlazorTestBase&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.html)
88+
- [IMockerBlazorTestHelpers&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.Interfaces.IMockerBlazorTestHelpers-1.html)
89+
- [ComponentState&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.Models.ComponentState-1.html)
9090

9191
## Fast ways to find a type
9292

9393
- Use the search box in the top-right and search for the exact type name, such as `Mocker` or `MockerTestBase`.
94-
- Use the site navigation to jump into [Core namespace](../../api/FastMoq.yml) when you know the type is in the main FastMoq namespace.
94+
- Use the site navigation to jump into [Core namespace](https://help.fastmoq.com/api/FastMoq.html) when you know the type is in the main FastMoq namespace.
9595
- Use [API overview](./index.md) when you want package-level entry points before drilling into a type.
9696

9797
## Typical navigation paths
9898

99-
- Starting a new service test: [MockerTestBase&lt;TComponent&gt;](../../api/FastMoq.MockerTestBase-1.yml) then [Mocker](../../api/FastMoq.Mocker.yml)
100-
- Configuring provider behavior: [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml) then [IMockingProvider](../../api/FastMoq.Providers.IMockingProvider.yml)
101-
- Writing a custom provider: [IMockingProvider](../../api/FastMoq.Providers.IMockingProvider.yml) then [IMockingProviderCapabilities](../../api/FastMoq.Providers.IMockingProviderCapabilities.yml) then [MockingProviderRegistry](../../api/FastMoq.Providers.MockingProviderRegistry.yml)
102-
- Verifying interactions: [TimesSpec](../../api/FastMoq.Providers.TimesSpec.yml) then [TestClassExtensions](../../api/FastMoq.Extensions.TestClassExtensions.yml)
103-
- Wiring Azure Functions worker tests: [FunctionContextTestExtensions](../../api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.yml) then [Mocker](../../api/FastMoq.Mocker.yml)
104-
- Working with Blazor components: [MockerBlazorTestBase&lt;T&gt;](../../api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.yml) then [IMockerBlazorTestHelpers&lt;T&gt;](../../api/FastMoq.Web.Blazor.Interfaces.IMockerBlazorTestHelpers-1.yml)
99+
- Starting a new service test: [MockerTestBase&lt;TComponent&gt;](https://help.fastmoq.com/api/FastMoq.MockerTestBase-1.html) then [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
100+
- Configuring provider behavior: [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html) then [IMockingProvider](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProvider.html)
101+
- Writing a custom provider: [IMockingProvider](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProvider.html) then [IMockingProviderCapabilities](https://help.fastmoq.com/api/FastMoq.Providers.IMockingProviderCapabilities.html) then [MockingProviderRegistry](https://help.fastmoq.com/api/FastMoq.Providers.MockingProviderRegistry.html)
102+
- Verifying interactions: [TimesSpec](https://help.fastmoq.com/api/FastMoq.Providers.TimesSpec.html) then [TestClassExtensions](https://help.fastmoq.com/api/FastMoq.Extensions.TestClassExtensions.html)
103+
- Wiring Azure Functions worker tests: [FunctionContextTestExtensions](https://help.fastmoq.com/api/FastMoq.AzureFunctions.Extensions.FunctionContextTestExtensions.html) then [Mocker](https://help.fastmoq.com/api/FastMoq.Mocker.html)
104+
- Working with Blazor components: [MockerBlazorTestBase&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.MockerBlazorTestBase-1.html) then [IMockerBlazorTestHelpers&lt;T&gt;](https://help.fastmoq.com/api/FastMoq.Web.Blazor.Interfaces.IMockerBlazorTestHelpers-1.html)

0 commit comments

Comments
 (0)