docs: fix documentation errors and remove examples#1000
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
Removes the in-repo Examples/ solution/projects and updates the Docusaurus docs to fix API/behavior descriptions (time system, file system, random system, compression), aligning documentation with the current library surface.
Changes:
- Delete the
Examples/solution, example projects, tests, and READMEs. - Update multiple docs pages to clarify usage patterns and API details (timers, auto-advance, notifications, initialization, drives, generators, migration).
- Adjust repo metadata/config to reflect docs as the primary documentation surface (Copilot instructions, Codacy exclusions).
Reviewed changes
Copilot reviewed 60 out of 63 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| Examples/ZipFile/ZipFile/ZipFileHelper.cs | Removed ZipFile example helper source. |
| Examples/ZipFile/ZipFile/ZipFile.csproj | Removed ZipFile example project. |
| Examples/ZipFile/ZipFile.Tests/ZipFileHelperTests.cs | Removed ZipFile example tests. |
| Examples/ZipFile/ZipFile.Tests/ZipFile.Tests.csproj | Removed ZipFile test project. |
| Examples/ZipFile/README.md | Removed ZipFile example README. |
| Examples/UnixFileMode/UnixFileMode/UnixFileMode.csproj | Removed UnixFileMode example project. |
| Examples/UnixFileMode/UnixFileMode/DefaultUnixFileModeStrategy.cs | Removed UnixFileMode example strategy implementation. |
| Examples/UnixFileMode/UnixFileMode.Tests/UnixFileMode.Tests.csproj | Removed UnixFileMode test project. |
| Examples/UnixFileMode/UnixFileMode.Tests/DefaultUnixFileModeStrategyTests.cs | Removed UnixFileMode example tests. |
| Examples/UnixFileMode/README.md | Removed UnixFileMode example README. |
| Examples/ThreadAwareTimeProvider/ThreadAwareTimeProvider/ThreadAwareTimeProvider.csproj | Removed ThreadAwareTimeProvider example project. |
| Examples/ThreadAwareTimeProvider/ThreadAwareTimeProvider/ThreadAwareTimeProvider.cs | Removed ThreadAwareTimeProvider example implementation. |
| Examples/ThreadAwareTimeProvider/ThreadAwareTimeProvider.Tests/ThreadAwareTimeProviderTests.cs | Removed ThreadAwareTimeProvider example tests. |
| Examples/ThreadAwareTimeProvider/ThreadAwareTimeProvider.Tests/ThreadAwareTimeProvider.Tests.csproj | Removed ThreadAwareTimeProvider test project. |
| Examples/ThreadAwareTimeProvider/README.md | Removed ThreadAwareTimeProvider example README. |
| Examples/SafeFileHandle/SafeFileHandle/UnmanagedFileLoader.cs | Removed SafeFileHandle example P/Invoke helper. |
| Examples/SafeFileHandle/SafeFileHandle/SafeFileHandle.csproj | Removed SafeFileHandle example project. |
| Examples/SafeFileHandle/SafeFileHandle/CustomSafeFileHandleStrategy.cs | Removed SafeFileHandle example strategy implementation. |
| Examples/SafeFileHandle/SafeFileHandle.Tests/SafeFileHandleTests.cs | Removed SafeFileHandle example tests. |
| Examples/SafeFileHandle/SafeFileHandle.Tests/SafeFileHandle.Tests.csproj | Removed SafeFileHandle test project. |
| Examples/SafeFileHandle/README.md | Removed SafeFileHandle example README. |
| Examples/README.md | Removed top-level Examples index README. |
| Examples/FileSystemWatcher/README.md | Removed FileSystemWatcher example README. |
| Examples/FileSystemWatcher/FileSystemWatcher.Tests/FileSystemWatcherTests.cs | Removed FileSystemWatcher example tests. |
| Examples/FileSystemWatcher/FileSystemWatcher.Tests/FileSystemWatcher.Tests.csproj | Removed FileSystemWatcher test project. |
| Examples/Examples.sln.DotSettings | Removed Examples solution Rider/ReSharper settings. |
| Examples/Examples.sln | Removed Examples solution. |
| Examples/DriveManagement/README.md | Removed DriveManagement example README. |
| Examples/DriveManagement/DriveManagement.Tests/DriveManagementTests.cs | Removed DriveManagement example tests. |
| Examples/DriveManagement/DriveManagement.Tests/DriveManagement.Tests.csproj | Removed DriveManagement test project. |
| Examples/Directory.Build.props | Removed Examples-specific MSBuild props. |
| Examples/Configuration/README.md | Removed Configuration example README. |
| Examples/Configuration/FileSystemConfiguration.Tests/NotificationTests.cs | Removed Configuration example tests (notifications). |
| Examples/Configuration/FileSystemConfiguration.Tests/InterceptionTests.cs | Removed Configuration example tests (interception). |
| Examples/Configuration/FileSystemConfiguration.Tests/InitializationTests.cs | Removed Configuration example tests (initialization). |
| Examples/Configuration/FileSystemConfiguration.Tests/FileSystemConfiguration.Tests.csproj | Removed FileSystemConfiguration test project. |
| Examples/Configuration/DependencyInjection.Tests/DependencyInjectionTests.cs | Removed DI example tests. |
| Examples/Configuration/DependencyInjection.Tests/DependencyInjection.Tests.csproj | Removed DI test project. |
| Examples/AccessControlLists/README.md | Removed ACL example README. |
| Examples/AccessControlLists/AccessControlLists/CustomAccessControlStrategy.cs | Removed ACL example strategy implementation. |
| Examples/AccessControlLists/AccessControlLists/AccessControlLists.csproj | Removed ACL example project. |
| Examples/AccessControlLists/AccessControlLists.Tests/AccessControlLists.Tests.csproj | Removed ACL test project. |
| Examples/AccessControlLists/AccessControlLists.Tests/AccessControlListTests.cs | Removed ACL example tests. |
| Examples/.idea/.idea.Examples/.idea/vcs.xml | Removed IDE metadata from Examples. |
| Examples/.idea/.idea.Examples/.idea/indexLayout.xml | Removed IDE metadata from Examples. |
| Examples/.idea/.idea.Examples/.idea/.gitignore | Removed IDE metadata from Examples. |
| Docs/pages/docs/time-system/timers.mdx | Updated timer testing guidance and ITimerMock.Wait details. |
| Docs/pages/docs/time-system/stopwatch.mdx | Corrected Stopwatch.Frequency description. |
| Docs/pages/docs/time-system/notifications.mdx | Refined PeriodicTimer notification naming/details. |
| Docs/pages/docs/time-system/auto-advance.mdx | Clarified disabling auto-advance via options. |
| Docs/pages/docs/random-system/deterministic-randomness.mdx | Clarified Generator<T> implicit conversions and usage. |
| Docs/pages/docs/migration-from-testableio.mdx | Reframed Testably vs TestableIO comparison text. |
| Docs/pages/docs/file-system/statistics.mdx | Adjusted “not recorded” section wording. |
| Docs/pages/docs/file-system/safe-file-handles.mdx | Clarified UnmanagedFileLoader description. |
| Docs/pages/docs/file-system/intercept-and-notify.mdx | Clarified IAwaitableCallback shape and wait semantics. |
| Docs/pages/docs/file-system/initialization.mdx | Documented temp directory seeding option + initializer errors. |
| Docs/pages/docs/file-system/index.mdx | Added overview of MockFileSystemOptions configuration. |
| Docs/pages/docs/file-system/extensibility.mdx | Updated strategy signature examples (UnixFileMode). |
| Docs/pages/docs/file-system/drives.mdx | Documented mutating drives at runtime via IStorageDrive. |
| Docs/pages/docs/companion-libraries/compression.mdx | Updated IZipArchive API surface description. |
| Docs/pages/README.md | Removed “keep examples docs in sync” guidance. |
| .github/copilot-instructions.md | Updated architecture section to reference Docs instead of Examples. |
| .codacy.yml | Removed Examples/** from Codacy exclusions. |
Files not reviewed (3)
- Examples/.idea/.idea.Examples/.idea/.gitignore: Language not supported
- Examples/.idea/.idea.Examples/.idea/indexLayout.xml: Language not supported
- Examples/.idea/.idea.Examples/.idea/vcs.xml: Language not supported
|
|
This is addressed in release v6.3.0. |
This was referenced May 16, 2026
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.
Removes the in-repo
Examples/solution/projects and updates the Docusaurus docs to fix API/behavior descriptions (time system, file system, random system, compression), aligning documentation with the current library surface.Changes:
Examples/solution, example projects, tests, and READMEs.