Skip to content

docs: move package markdown files to dedicated directory#927

Merged
vbreuss merged 2 commits intomainfrom
topic/move-package-readme
Jan 29, 2026
Merged

docs: move package markdown files to dedicated directory#927
vbreuss merged 2 commits intomainfrom
topic/move-package-readme

Conversation

@vbreuss
Copy link
Member

@vbreuss vbreuss commented Jan 29, 2026

This PR reorganizes package documentation by moving README files from the Docs/ directory into a new Docs/Nuget/ subdirectory to improve documentation structure.

Key Changes:

  • Moved four package README files (AccessControl.md, Compression.md, Interface.md, Testing.md) to Docs/Nuget/ subdirectory
  • Updated solution file to reflect new documentation structure with a "Nuget" folder under "Docs"
  • Updated all project file references to point to the new documentation locations
  • Replaced incorrect relative link to Testably.Abstractions with an absolute link

@vbreuss vbreuss self-assigned this Jan 29, 2026
@vbreuss vbreuss added the documentation Improvements or additions to documentation label Jan 29, 2026
Copilot AI review requested due to automatic review settings January 29, 2026 08:29
Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR reorganizes package documentation by moving README files from the Docs/ directory into a new Docs/Nuget/ subdirectory to improve documentation structure.

Changes:

  • Moved four package README files (AccessControl.md, Compression.md, Interface.md, Testing.md) to Docs/Nuget/ subdirectory
  • Updated solution file to reflect new documentation structure with a "Nuget" folder under "Docs"
  • Updated all project file references to point to the new documentation locations

Reviewed changes

Copilot reviewed 10 out of 10 changed files in this pull request and generated no comments.

Show a summary per file
File Description
Testably.Abstractions.sln Reorganized solution structure to move package documentation references from root Docs section to a new Packages subfolder
Source/Testably.Abstractions.Testing/Testably.Abstractions.Testing.csproj Updated package path to reference Testing.md from new Docs/Packages location
Source/Testably.Abstractions.Interface/Testably.Abstractions.Interface.csproj Updated package path to reference Interface.md from new Docs/Packages location
Source/Testably.Abstractions.FileSystem.Interface/Testably.Abstractions.FileSystem.Interface.csproj Updated package path to reference Interface.md from new Docs/Packages location
Source/Testably.Abstractions.Compression/Testably.Abstractions.Compression.csproj Updated package path to reference Compression.md from new Docs/Packages location
Source/Testably.Abstractions.AccessControl/Testably.Abstractions.AccessControl.csproj Updated package path to reference AccessControl.md from new Docs/Packages location
Docs/Testing.md Deleted file - content moved to Docs/Packages/Testing.md
Docs/Interface.md Deleted file - content moved to Docs/Packages/Interface.md
Docs/Compression.md Deleted file - content moved to Docs/Packages/Compression.md
Docs/AccessControl.md Deleted file - content moved to Docs/Packages/AccessControl.md

@vbreuss vbreuss force-pushed the topic/move-package-readme branch from f8ce81c to e39f4d2 Compare January 29, 2026 08:32
@vbreuss vbreuss changed the title docs: move package readme to dedicated directory docs: move package markdown files to dedicated directory Jan 29, 2026
@github-actions
Copy link

github-actions bot commented Jan 29, 2026

Test Results

     52 files  ±0       52 suites  ±0   34m 16s ⏱️ +24s
 63 869 tests  - 3   60 255 ✅  - 4   3 613 💤 ±0  1 ❌ +1 
131 773 runs  ±0  117 262 ✅  - 1  14 510 💤 ±0  1 ❌ +1 

For more details on these failures, see this check.

Results for commit 22a80eb. ± Comparison against base commit 6caeb8c.

This pull request removes 55337 and adds 55334 tests. Note that renamed tests count towards both.
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path24fe7350-6750-4166-a608-194d29e2f340")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path264802ad-2a8d-40d1-8186-ada331ad6ee8")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path39ac9c29-0be9-4dbf-91a5-ddd83de3a904")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path53024fea-b453-4279-a8d6-33b219885a14")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path77d6d219-d38d-493d-916d-1cd0f774c136")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path9270cfc9-b877-4129-87da-8305901a9ff7")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path92c6fea5-ce25-4fee-8afd-c21339e7fcf1")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path9ed469e2-b5d7-4c3a-bc55-36f37b53248b")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathca003828-8d2d-48a2-accf-cf600ed8fb68")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathf0a0235a-326d-48e9-bb0e-be026b818b32")
…
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path0e00229f-2cf9-4d3d-a96e-36e27b2d6f19")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path0eb425f5-0f8f-4ff0-9bf4-30b9558adfb7")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path1d4e6d5a-1669-4a39-b4d7-3e3e30374927")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path6e58bd54-8a43-441c-935e-6c635fbfbfa6")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path8497f942-d951-4e00-8fbf-de5270368783")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path86ae4b5d-b04d-4bc6-b612-d55995a04298")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathb4cb0c47-91d6-49e1-843c-cb82cc1edf7d")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathc0f3c8ec-0ca1-41d3-a0fb-69fcb7667684")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathc428f9d8-0e05-4921-9cab-266ea3e4b898")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathe28f54d8-c093-4fa6-84c9-4ba712efa3d6")
…
This pull request removes 2920 skipped tests and adds 2920 skipped tests. Note that renamed tests count towards both.
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path53024fea-b453-4279-a8d6-33b219885a14")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path77d6d219-d38d-493d-916d-1cd0f774c136")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path92c6fea5-ce25-4fee-8afd-c21339e7fcf1")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path9ed469e2-b5d7-4c3a-bc55-36f37b53248b")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathca003828-8d2d-48a2-accf-cf600ed8fb68")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathf0a0235a-326d-48e9-bb0e-be026b818b32")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path0aedd024-4732-458b-912d-c1e1c997c35e")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path52e9dd5a-003d-482f-9802-944142361b1a")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path830cc68d-c361-4218-acd9-a071af76bf9f")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "patha41055c1-b577-4a03-aec4-d0ce249b32ad")
…
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path0e00229f-2cf9-4d3d-a96e-36e27b2d6f19")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path1d4e6d5a-1669-4a39-b4d7-3e3e30374927")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path8497f942-d951-4e00-8fbf-de5270368783")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathb4cb0c47-91d6-49e1-843c-cb82cc1edf7d")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathc0f3c8ec-0ca1-41d3-a0fb-69fcb7667684")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+MockFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "pathc428f9d8-0e05-4921-9cab-266ea3e4b898")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path0305f785-7ced-45d2-9966-14e5cf83a33b")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path31f07d52-dacb-4f6f-9500-9e8b33b025c6")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path54a903b3-0a12-4178-8c33-889918cdf13f")
Testably.Abstractions.AccessControl.Tests.DirectoryInfoAclExtensionsTests+RealFileSystemTests ‑ SetAccessControl_ShouldNotUpdateTimes(path: "path5a54efb8-cb09-48f0-b04c-a819be68a6fb")
…

♻️ This comment has been updated with latest results.

@vbreuss vbreuss enabled auto-merge (squash) January 29, 2026 09:41
@sonarqubecloud
Copy link

@vbreuss vbreuss merged commit ab184d2 into main Jan 29, 2026
20 of 22 checks passed
@vbreuss vbreuss deleted the topic/move-package-readme branch January 29, 2026 10:34
@github-actions
Copy link

github-actions bot commented Feb 2, 2026

This is addressed in release v5.1.0.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation state: released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants