docs: refresh package READMEs and split Interface README#1015
Merged
Conversation
- Rewrite the four Docs/Nuget/*.md package READMEs to reflect current functionality (PeriodicTimer, replay notifications, statistics, OS simulation, async zip overloads, full ACL surface) and link to docs.testably.org/Abstractions/. - Add Docs/Nuget/FileSystemInterface.md and repoint the Testably.Abstractions.FileSystem.Interface csproj at it, so that package no longer ships the shared Interface.md that described ITimeSystem and IRandomSystem it does not contain. - Drop the stale Expect.That example from Testing.md; the bullets describe the surface and the docs site has full examples. - Update root README.md docs links to the /Abstractions/ slug and expand "BCL" on first use as "base class library (BCL)".
There was a problem hiding this comment.
Pull request overview
This PR refreshes NuGet package READMEs to better reflect current Testably.Abstractions features and splits the file-system-interface package README so it no longer ships a shared interface README describing unrelated APIs.
Changes:
- Updated root
README.mdto point documentation links at the new docs slug and expanded “base class library (BCL)” on first use. - Rewrote package READMEs under
Docs/Nuget/(Testing, Interface, Compression, AccessControl) and added a newFileSystemInterface.md. - Repointed
Testably.Abstractions.FileSystem.Interfaceto ship and reference the new package-specific README.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 7 comments.
Show a summary per file
| File | Description |
|---|---|
| Source/Testably.Abstractions.FileSystem.Interface/Testably.Abstractions.FileSystem.Interface.csproj | Points package README to the new file-system-interface-specific markdown. |
| README.md | Updates top-level documentation links and wording in the project overview. |
| Docs/Nuget/Testing.md | Replaces long example with a condensed feature/links-focused package README. |
| Docs/Nuget/Interface.md | Updates interface package README to current scope and doc links. |
| Docs/Nuget/FileSystemInterface.md | Adds a dedicated README for the file-system interface-only package. |
| Docs/Nuget/Compression.md | Updates compression package README and docs link. |
| Docs/Nuget/AccessControl.md | Updates access-control package README and docs link. |
Comments suppressed due to low confidence (2)
README.md:47
- Docs URLs appear to be lower-case (
/abstractions/…perDocs/pages/docs/index.mdx). This link uses/Abstractions/getting-started; consider usinghttps://docs.testably.org/abstractions/getting-startedto avoid case-sensitive 404s.
Then register the implementations in your DI container - see [Getting Started](https://docs.testably.org/Abstractions/getting-started).
README.md:60
- Docs URLs appear to be lower-case (
/abstractions/…perDocs/pages/docs/index.mdx). This migration-guide link uses/Abstractions/...; consider switching tohttps://docs.testably.org/abstractions/migration-from-testableio.
## Already on TestableIO?
`Testably.Abstractions` shares the `IFileSystem` interface with [TestableIO.System.IO.Abstractions](https://github.com/TestableIO/System.IO.Abstractions), so production code stays untouched. See the [migration guide](https://docs.testably.org/Abstractions/migration-from-testableio).
|
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.



Uh oh!
There was an error while loading. Please reload this page.