Skip to content

docs: move package markdown files to dedicated directory #927

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
vbreuss merged 2 commits into from
Jan 29, 2026
Merged

docs: move package markdown files to dedicated directory #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e39f4d2
docs: move package readme to dedicated directory
vbreuss Jan 29, 2026
22a80eb
Fix link in package readme
vbreuss Jan 29, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion Docs/AccessControl.md → Docs/Nuget/AccessControl.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=alert_status)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=coverage)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)

ACL (access control list) extension methods for [Testably.Abstractions](../README.md) using [System.IO.FileSystem.AccessControl](https://www.nuget.org/packages/System.IO.FileSystem.AccessControl/).
ACL (access control list) extension methods for [Testably.Abstractions](https://github.com/Testably/Testably.Abstractions) using [System.IO.FileSystem.AccessControl](https://www.nuget.org/packages/System.IO.FileSystem.AccessControl/).
Implements the methods from [FileSystemAclExtensions](https://learn.microsoft.com/en-us/dotnet/api/system.io.filesystemaclextensions) on the `IFileSystem` interface.

## Example
Expand Down
2 changes: 1 addition & 1 deletion Docs/Compression.md → Docs/Nuget/Compression.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=alert_status)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=coverage)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)

Compression extensions for [Testably.Abstractions](../README.md) using [System.IO.Compression](https://www.nuget.org/packages/System.IO.Compression/).
Compression extensions for [Testably.Abstractions](https://github.com/Testably/Testably.Abstractions) using [System.IO.Compression](https://www.nuget.org/packages/System.IO.Compression/).
Wraps the static methods from [ZipFile](https://learn.microsoft.com/en-us/dotnet/api/system.io.compression.zipfile) in an extension on `IFileSystem`.

## Example
Expand Down
2 changes: 1 addition & 1 deletion Docs/Interface.md → Docs/Nuget/Interface.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=alert_status)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=coverage)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)

This library contains the abstraction interfaces for [Testably.Abstractions](../README.md), which allow replacing system dependencies:
This library contains the abstraction interfaces for [Testably.Abstractions](https://github.com/Testably/Testably.Abstractions), which allow replacing system dependencies:

- The `IFileSystem` interface abstracts away all I/O-related functionality from the `System.IO` namespace:
Static methods are directly implemented on the `IFileSystem` interface.
Expand Down
2 changes: 1 addition & 1 deletion Docs/Testing.md → Docs/Nuget/Testing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=alert_status)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)
[![Coverage](https://sonarcloud.io/api/project_badges/measure?project=Testably_Testably.Abstractions&branch=main&metric=coverage)](https://sonarcloud.io/summary/overall?id=Testably_Testably.Abstractions&branch=main)

This library contains the testing helpers for [Testably.Abstractions](../README.md).
This library contains the testing helpers for [Testably.Abstractions](https://github.com/Testably/Testably.Abstractions).

## MockFileSystem

Expand Down
2 changes: 1 addition & 1 deletion Source/Testably.Abstractions.AccessControl/Testably.Abstractions.AccessControl.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="$(SolutionDir)Docs/AccessControl.md"
<None Include="$(SolutionDir)Docs/Nuget/AccessControl.md"
Pack="true" PackagePath="/Docs/"
Link="Docs\AccessControl.md" />
</ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Source/Testably.Abstractions.Compression/Testably.Abstractions.Compression.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="$(SolutionDir)Docs/Compression.md"
<None Include="$(SolutionDir)Docs/Nuget/Compression.md"
Pack="true" PackagePath="/Docs/"
Link="Docs\Compression.md" />
</ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion ...tably.Abstractions.FileSystem.Interface/Testably.Abstractions.FileSystem.Interface.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="$(SolutionDir)Docs/Interface.md" Pack="true" PackagePath="/Docs/" Link="Docs\Interface.md" />
<None Include="$(SolutionDir)Docs/Nuget/Interface.md" Pack="true" PackagePath="/Docs/" Link="Docs\Interface.md" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Source/Testably.Abstractions.Interface/Testably.Abstractions.Interface.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="$(SolutionDir)Docs/Interface.md" Pack="true" PackagePath="/Docs/" Link="Docs\Interface.md" />
<None Include="$(SolutionDir)Docs/Nuget/Interface.md" Pack="true" PackagePath="/Docs/" Link="Docs\Interface.md" />
</ItemGroup>

<ItemGroup>
Expand Down
2 changes: 1 addition & 1 deletion Source/Testably.Abstractions.Testing/Testably.Abstractions.Testing.csproj
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@
</PropertyGroup>

<ItemGroup>
<None Include="$(SolutionDir)Docs/Testing.md" Pack="true" PackagePath="/Docs/" Link="Docs\Testing.md" />
<None Include="$(SolutionDir)Docs/Nuget/Testing.md" Pack="true" PackagePath="/Docs/" Link="Docs\Testing.md" />
</ItemGroup>

<ItemGroup>
Expand Down
15 changes: 9 additions & 6 deletions Testably.Abstractions.sln
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,12 +68,6 @@ EndProject
Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Testably.Abstractions.Compression.Tests", "Tests\Testably.Abstractions.Compression.Tests\Testably.Abstractions.Compression.Tests.csproj", "{5330AEEE-A915-4FF6-A85D-E9CCA161B654}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{4D70CF83-2EEE-439E-AA30-3FADAACAEB0C}"
ProjectSection(SolutionItems) = preProject
Docs\AccessControl.md = Docs\AccessControl.md
Docs\Compression.md = Docs\Compression.md
Docs\Interface.md = Docs\Interface.md
Docs\Testing.md = Docs\Testing.md
EndProjectSection
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Helpers", "Helpers", "{B6C45D8A-A545-402E-A6B0-47BC7D9BBCF5}"
EndProject
Expand Down Expand Up @@ -104,6 +98,14 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Core", "Core", "{F049D1AF-3
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Testably.Abstractions.Core.Api.Tests", "Tests\Api\Testably.Abstractions.Core.Api.Tests\Testably.Abstractions.Core.Api.Tests.csproj", "{CF5BBD40-DC43-4B0C-8521-ACD3B8ABFF20}"
EndProject
Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Nuget", "Nuget", "{B9E1E12B-9E7F-415A-B956-567694022C27}"
ProjectSection(SolutionItems) = preProject
Docs\Nuget\AccessControl.md = Docs\Nuget\AccessControl.md
Docs\Nuget\Compression.md = Docs\Nuget\Compression.md
Docs\Nuget\Interface.md = Docs\Nuget\Interface.md
Docs\Nuget\Testing.md = Docs\Nuget\Testing.md
EndProjectSection
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Expand Down Expand Up @@ -204,6 +206,7 @@ Global
{B9DFD3C7-44B7-4A38-A2B7-A96B5BC3651C} = {F049D1AF-3FB0-43F0-B7EE-225C37D5D142}
{E447F0BC-7630-41E2-9EA3-DC065827694C} = {F049D1AF-3FB0-43F0-B7EE-225C37D5D142}
{CF5BBD40-DC43-4B0C-8521-ACD3B8ABFF20} = {8A44FA00-968E-4CEC-90E6-94A878B9DEB2}
{B9E1E12B-9E7F-415A-B956-567694022C27} = {4D70CF83-2EEE-439E-AA30-3FADAACAEB0C}
EndGlobalSection
GlobalSection(ExtensibilityGlobals) = postSolution
SolutionGuid = {EC4D8481-B9FD-41B5-832A-369210993DF4}
Expand Down