Skip to content
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.

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

[release/8.0] Add package readmes (continued) #93769

Merged
merged 15 commits into from
Oct 20, 2023

Conversation

ViktorHofer
Copy link
Member

Backport of #92228
Continuation of #91210

One of the top customer problems that package consumers are facing is lack of documentation. As such, we are driving an effort to increase the adoption and quality of NuGet package READMEs.


This tell-mode change backports the 12 new package readmes into the release/8.0 branch.

🥳🥳🥳 Kudos to 🥳🥳🥳

This wouldn't have been possible without your dedication.

ViktorHofer and others added 14 commits October 20, 2023 09:48
Typo in word 'Defult' fixed to 'Default'.

Fix #92228
* Remove conceptual docummentation item

Removed since is not applicable

* List types library provides

Add list of types which library provides. Listed
public types, means exposed types.

* Add description and usage examples

Add library description. Add few code examples
showing basic functionality for CBOR wirter and reader
types.

* Add related packages section

Since different targets have different dependencies
so I have divided for each section.

* Improve short description

Add 'format' word after abbreviation to have an object
in sentence.

* Remove related packages section

Since there are no related packages.

* Improve array reading/writing example
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md

Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme

See #92228

* Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md

* Update src/libraries/Microsoft.Extensions.FileSystemGlobbing/src/PACKAGE.md

---------

Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
#93489)

* Provide FileProviders.Abstractions package readme

* Improve how to use section
…93485)

* Provide FileProviders.Physical package readme

* Remove whitespace
)

* Provide Caching.Abstractions package readme

* Process feedback
* Provide System.Memory.Data package readme

* Update src/libraries/System.Memory.Data/src/PACKAGE.md

---------

Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
…3660)

* Provide Cryptography.ProtectedData package readme

* Processing review comments

* Remove paragraph and improve sentence

* Improve code sample
@ViktorHofer ViktorHofer added Servicing-approved Approved for servicing release area-Meta labels Oct 20, 2023
@ViktorHofer ViktorHofer added this to the 8.0.0 milestone Oct 20, 2023
@ViktorHofer ViktorHofer self-assigned this Oct 20, 2023
@ghost
Copy link

ghost commented Oct 20, 2023

Tagging subscribers to this area: @dotnet/area-meta
See info in area-owners.md if you want to be subscribed.

Issue Details

Backport of #92228
Continuation of #91210

One of the top customer problems that package consumers are facing is lack of documentation. As such, we are driving an effort to increase the adoption and quality of NuGet package READMEs.


This tell-mode change backports the 12 new package readmes into the release/8.0 branch.

🥳🥳🥳 Kudos to 🥳🥳🥳

This wouldn't have been possible without your dedication.

Author: ViktorHofer
Assignees: ViktorHofer
Labels:

Servicing-approved, area-Meta

Milestone: 8.0.0

@ViktorHofer ViktorHofer merged commit 0250277 into release/8.0 Oct 20, 2023
12 checks passed
@ViktorHofer ViktorHofer deleted the PackageReadmesContinued80Backport branch October 20, 2023 08:10
@ghost ghost locked as resolved and limited conversation to collaborators Nov 19, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Meta Servicing-approved Approved for servicing release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants