Skip to content

docs: fix headers in package READMEs#1012

Merged
vbreuss merged 1 commit into
mainfrom
topic/fix-package-readme
May 17, 2026
Merged

docs: fix headers in package READMEs#1012
vbreuss merged 1 commit into
mainfrom
topic/fix-package-readme

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented May 17, 2026

No description provided.

@vbreuss vbreuss self-assigned this May 17, 2026
Copilot AI review requested due to automatic review settings May 17, 2026 09:23
@vbreuss vbreuss added the documentation Improvements or additions to documentation label May 17, 2026
@vbreuss vbreuss merged commit a871ca4 into main May 17, 2026
9 of 11 checks passed
@vbreuss vbreuss deleted the topic/fix-package-readme branch May 17, 2026 09:24
Copy link
Copy Markdown

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

Updates the NuGet package README markdown files under Docs/Nuget/ to render with proper top-level headings (instead of the previous image-based “header”), improving how these READMEs appear on NuGet and other markdown renderers.

Changes:

  • Added an H1 title to each package README in Docs/Nuget/.
  • Removed the previous image-only “header” line to avoid malformed/undesired rendering.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.

File Description
Docs/Nuget/Testing.md Adds an H1 title for the Testing package README.
Docs/Nuget/Interface.md Adds an H1 title for the Interface README, but note it’s used by multiple packages (title may be incorrect for one).
Docs/Nuget/Compression.md Adds an H1 title for the Compression package README.
Docs/Nuget/AccessControl.md Adds an H1 title for the AccessControl package README.

Comment thread Docs/Nuget/Interface.md
Comment on lines +1 to +2
# Testably.Abstractions.Interface

@sonarqubecloud
Copy link
Copy Markdown

@github-actions
Copy link
Copy Markdown

This is addressed in release v6.4.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