Skip to content

General documentation improvements for readme file#1606

Merged
clairernovotny merged 7 commits intomainfrom
copilot/improve-readme-documentation
Oct 9, 2025
Merged

General documentation improvements for readme file#1606
clairernovotny merged 7 commits intomainfrom
copilot/improve-readme-documentation

Conversation

Copy link
Contributor

Copilot AI commented Oct 9, 2025

  • Update NuGet package link from nuget.org to www.nuget.org
  • Create a table for language package options with install commands
  • Change code block syntax from C# to csharp for better highlighting (96 occurrences)
  • Clarify netstandard2 framework support explanation
  • Improve SourceLink description for better clarity
  • Add badges section at the top (build status, NuGet version, downloads)
  • Add Contributing section with link to CONTRIBUTING.md
  • Add License section with link to license.txt
  • Add Bug Reports/Issues section
  • Use Humanizer.Core for downloads badge
  • Use dotnet add package commands in table
  • Restructure framework support explanation for clarity
Original prompt

This section details on the original issue you should resolve

<issue_title>General documentation improvements for the readme file</issue_title>
<issue_description>This issue is to suggest improvements and clarify a few points in the Humanizer readme file:

  1. Framework Support Description

    • The explanation around supported frameworks and netstandard2 compatibility is confusing. Consider clarifying why some frameworks (e.g., net4.6.1 to net4.7.2) are explicitly not supported despite netstandard2 compatibility.
  2. NuGet Package Link

    • Update the NuGet link to use the official domain: https://www.nuget.org/packages/Humanizer instead of https://nuget.org/packages/Humanizer.
  3. Language Packages Section

    • Consider using a table to show the options for all/English/specific languages, including install commands and which languages are included.
  4. Formatting

    • The code samples use C# for markdown blocks; switching to csharp may improve syntax highlighting.
  5. SourceLink Section

    • The explanation about SourceLink could be reworded for clarity, e.g., "This means you can step through Humanizer's source code while debugging your own application."
  6. Missing Information

    • Add sections for contributions, license, and where to report bugs.
    • Consider adding badges for build status, NuGet version, downloads, etc.
    • A troubleshooting or FAQ section might help new users.

These changes would help make the readme clearer and more useful for both new and experienced users.


If maintainers need more specific suggestions or want help with the markdown, I am happy to contribute further!</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #1601

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Co-authored-by: clairernovotny <1427284+clairernovotny@users.noreply.github.com>
Copilot AI changed the title [WIP] Update readme for improved clarity and accuracy General documentation improvements for readme file Oct 9, 2025
Copilot AI requested a review from clairernovotny October 9, 2025 00:21
Copy link
Member

@clairernovotny clairernovotny left a comment

Choose a reason for hiding this comment

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

@copilot Overall looks good but for the downloads, make sure to use Humanizer.Core as the source for that. And for the options table, use the dotnet command

@clairernovotny clairernovotny marked this pull request as ready for review October 9, 2025 02:09
Copilot AI review requested due to automatic review settings October 9, 2025 02:09
Copy link
Contributor

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 significantly improves the Humanizer readme file with comprehensive documentation enhancements based on user feedback. The changes focus on making the readme more professional, user-friendly, and informative for both new and experienced developers.

Key changes include:

  • Added professional badges section with build status, NuGet version, and download metrics
  • Improved framework support documentation with clearer explanations of compatibility limitations
  • Replaced language packages bullet list with a comprehensive markdown table format

readme.md Outdated
Comment on lines 21 to 24
The following frameworks are supported: net48, net6.0, net7.0, and net8.0

Note: The nuget also targets netstandard2. This is to enable scenario where netstandard2 is required. For example Roslyn Analyzers or MSBuild tasks. Other frameworks (other than listed above) that can consume netstandard2 (example net4.6.1 through to net 4.7.2) are not supported. For example net4.6.1 through to net4.7.2 are not supported.
The NuGet package also targets netstandard2.0 to support specific scenarios such as Roslyn Analyzers and MSBuild tasks that require netstandard2.0. While other .NET Framework versions (net4.6.1 through net4.7.2) can technically consume netstandard2.0 libraries, they are **not officially supported** by Humanizer and may not work correctly. Please use one of the explicitly supported frameworks listed above for the best experience.

Copy link

Copilot AI Oct 9, 2025

Choose a reason for hiding this comment

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

[nitpick] The framework support explanation could be clearer. Consider restructuring to first state what IS supported, then explain the netstandard2.0 targeting as a special case, and finally clarify the unsupported versions.

Copilot uses AI. Check for mistakes.
clairernovotny and others added 2 commits October 8, 2025 23:11
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@clairernovotny
Copy link
Member

@copilot The framework support explanation could be clearer. Consider restructuring to first state what IS supported, then explain the netstandard2.0 targeting as a special case, and finally clarify the unsupported versions.

…ands, and clearer framework support

Co-authored-by: clairernovotny <1427284+clairernovotny@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Oct 9, 2025

@copilot The framework support explanation could be clearer. Consider restructuring to first state what IS supported, then explain the netstandard2.0 targeting as a special case, and finally clarify ...

Restructured the framework support section with clear headings:

  • Supported frameworks: lists what IS supported
  • netstandard2.0 targeting: explains the special case
  • Unsupported versions: clarifies what's not supported

This makes it much easier to scan and understand. (commit: 5ac7052)

@copilot Overall looks good but for the downloads, make sure to use Humanizer.Core as the source for that. And for the options table, use the dotnet command

Updated! Changed the downloads badge to use Humanizer.Core and replaced Install-Package commands with dotnet add package commands in the table. (commit: 5ac7052)

Updated NuGet badge links to include logo and prerelease information.
@clairernovotny clairernovotny merged commit 384379e into main Oct 9, 2025
3 of 5 checks passed
@clairernovotny clairernovotny deleted the copilot/improve-readme-documentation branch October 9, 2025 03:43
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

General documentation improvements for the readme file

2 participants