Add package readmes (continued) - #92228

Merged
ViktorHofer merged 25 commits into
mainfrom
PackageReadmesContinued
Jan 22, 2024
Merged

Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom
PackageReadmesContinued

Conversation

@ViktorHofer

@ViktorHoferViktorHofer commented Sep 18, 2023•
edited by BrennanConroy
Loading

Copy link
Copy Markdown
Member

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.

Ask

To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.

Why

The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.

How

This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.

Packages

This list is sorted alphabetically.

PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit

✅ (:white_check_mark:) -> reviewed & approved

🕜 (:clock130:) -> under review

cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight

@ViktorHoferViktorHofer added this to the 9.0.0 milestone Sep 18, 2023
@ghost

ghost commented Sep 18, 2023

Copy link
Copy Markdown

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

Issue Details

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.

Ask

To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.

Why

The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.

How

This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.

Packages

This list is sorted alphabetically.

PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit

✅ (:white_check_mark:) -> reviewed & approved

🕜 (:clock130:) -> under review

cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight

Author:ViktorHofer
Assignees:-
Labels:

area-Meta

Milestone:9.0.0

@ViktorHoferViktorHofer removed their assignment Oct 2, 2023
@ViktorHoferViktorHofer mentioned this pull request Oct 3, 2023
Closed
@danmoseley

danmoseley commented Oct 3, 2023

Copy link
Copy Markdown
Contributor

Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this

@ViktorHoferViktorHofer added the help wanted [up-for-grabs] Good issue for external contributors label Oct 3, 2023
@ViktorHofer

ViktorHofer commented Oct 3, 2023•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this

Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...

illialarka added a commit to illialarka/runtime that referenced this pull request Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit to illialarka/runtime that referenced this pull request Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit to illialarka/runtime that referenced this pull request Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit to illialarka/runtime that referenced this pull request Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka mentioned this pull request Oct 3, 2023
Merged
@tarekghtarekgh mentioned this pull request Oct 3, 2023
Closed
illialarka added a commit to illialarka/runtime that referenced this pull request Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka mentioned this pull request Oct 4, 2023
Merged
EnsignPayton added a commit to EnsignPayton/runtime that referenced this pull request Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton mentioned this pull request Oct 6, 2023
Merged
illialarkaand others added 3 commits October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545
This was referenced Oct 13, 2023
Merged
Merged
Merged
@eNeRGy164eNeRGy164 mentioned this pull request Nov 2, 2023
Merged
This was referenced Nov 4, 2023
Merged
Closed
@eNeRGy164

eNeRGy164 commented Nov 4, 2023

Copy link
Copy Markdown
Contributor

I learn a lot on APIs I never had a reason to use. 😝

@eNeRGy164eNeRGy164 mentioned this pull request Nov 5, 2023
Closed
@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>
This was referenced Nov 9, 2023
Closed
Merged
Merged
Merged
Merged
@ghostghost closed this Jan 7, 2024
@ghost

ghost commented Jan 7, 2024

Copy link
Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.

@ViktorHoferViktorHofer reopened this Jan 8, 2024
@ViktorHofer
ViktorHofer marked this pull request as ready for review January 22, 2024 17:42
@ViktorHofer

ViktorHofer commented Jan 22, 2024•
edited
Loading

Copy link
Copy Markdown
MemberAuthor

I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.

And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉

ericstj
ericstj approved these changes Jan 22, 2024
View reviewed changes

@ericstjericstj left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.

@ViktorHofer
ViktorHofer merged commit 5aabefa into mainJan 22, 2024
@ViktorHofer
ViktorHofer deleted the PackageReadmesContinued branch January 22, 2024 18:04
tmds pushed a commit to tmds/runtime that referenced this pull request Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit to tmds/runtime that referenced this pull request Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit to tmds/runtime that referenced this pull request Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot locked and limited conversation to collaborators Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees

No one assigned

Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects

None yet

Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Universal Dark Mode - works on any site\n(function() {\n var enabled = true;\n \n function applyDarkMode() {\n if (!enabled) return;\n \n // Create style element if it doesn't exist\n var style = document.getElementById('universal-dark-mode-style');\n if (!style) {\n style = document.createElement('style');\n style.id = 'universal-dark-mode-style';\n document.head.appendChild(style);\n }\n \n // Dark mode CSS - inverts colors but preserves images/video\n style.textContent = '\n /* Invert everything except media */\n html {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #1a1a2e !important;\n }\n \n /* Restore images, videos, iframes, canvas */\n img, video, iframe, canvas, svg, picture, [style*=\"background-image\"] {\n filter: invert(1) hue-rotate(180deg) !important;\n }\n \n /* Preserve specific elements that should not be inverted */\n .no-dark-mode, .no-dark-mode *,\n [data-theme=\"light\"], [data-theme=\"light\"],\n .ace_editor, .ace_editor *,\n .CodeMirror, .CodeMirror *,\n .monaco-editor, .monaco-editor *,\n .markdown-body pre, .markdown-body pre *,\n .highlight, .highlight *,\n pre code, pre code * {\n filter: none !important;\n }\n \n /* Fix common UI elements */\n .modal, .popup, .dropdown-menu, .tooltip, .popover {\n filter: invert(1) hue-rotate(180deg) !important;\n background: #2d2d44 !important;\n border-color: #444 !important;\n }\n \n /* Scrollbars */\n ::-webkit-scrollbar { background: #1a1a2e !important; }\n ::-webkit-scrollbar-thumb { background: #444 !important; }\n ::-webkit-scrollbar-thumb:hover { background: #555 !important; }\n \n /* Selection */\n ::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }\n ';\n }\n \n function removeDarkMode() {\n var style = document.getElementById('universal-dark-mode-style');\n if (style) style.remove();\n }\n \n // Toggle with Alt+Shift+D\n document.addEventListener('keydown', function(e) {\n if (e.altKey && e.shiftKey && e.key === 'D') {\n e.preventDefault();\n enabled = !enabled;\n if (enabled) {\n applyDarkMode();\n console.log('[Universal Dark Mode] Enabled');\n } else {\n removeDarkMode();\n console.log('[Universal Dark Mode] Disabled');\n }\n }\n });\n \n // Apply on load\n applyDarkMode();\n \n // Re-apply on dynamic content\n var observer = new MutationObserver(function(mutations) {\n if (enabled && !document.getElementById('universal-dark-mode-style')) {\n applyDarkMode();\n }\n });\n observer.observe(document.head, { childList: true });\n \n console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');\n})();", "Universal Dark Mode");
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();

Skip to content
Add package readmes (continued) - #92228
Merged
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Jan 22, 2024
Merged
Add package readmes (continued)#92228
ViktorHofer merged 25 commits into
mainfrom 
PackageReadmesContinued
Conversation
@ViktorHofer
@ViktorHoferViktorHofer
commented
Sep 18, 2023•

edited by BrennanConroy

Loading

Copy link


Copy Markdown

Member
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit✅
Microsoft.Extensions.Caching.AbstractionsEdit✅
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit✅
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit✅
Microsoft.Extensions.FileSystemGlobbingEdit✅
Microsoft.Extensions.Hosting.SystemdEdit✅
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit✅
Microsoft.Extensions.Options.DataAnnotationsEdit✅
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit✅
Microsoft.Win32.SystemEventsEdit✅
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit✅
System.Formats.CborEdit✅
System.IO.HashingEdit✅
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit✅
System.Numerics.TensorsEdit✅
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit✅
System.Text.Encodings.WebEdit✅
System.Threading.AccessControlEdit✅
System.Threading.RateLimitingEdit✅
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
@ViktorHoferViktorHofer
added this to the 9.0.0 milestone
Sep 18, 2023
@ghost
ghost
commented
Sep 18, 2023

Copy link


Copy Markdown

Tagging subscribers to this area: @dotnet/area-meta

See info in area-owners.md if you want to be subscribed.
Issue Details
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.
Ask
To lead by example and ensure that our packages have the maximum impact, we would greatly appreciate your support in increasing the adoption and quality of NuGet package READMEs.
Why
The README file is an essential part of your package as it provides important information to users and helps them understand what the package is and what it does quickly. Also, README is the first things for users when they view your package on NuGet.org and soon other tooling, it is crucial for package authors to write and include high-quality READMEs for their packages.
How
This PR initializes READMEs for all the below listed packages. Please directly push to this branch and also use this PR by your POD area team to review changes. For a great example, please see System.Text.Json's package README. Expect to spend ~30min of your time per README. Please try to keep documentation as minimal as possible to avoid duplicating information that is already available on docs.microsoft.com.
Packages
This list is sorted alphabetically.
PackageStatus
Microsoft.Bcl.CryptographyEdit
Microsoft.Extensions.Caching.AbstractionsEdit
Microsoft.Extensions.DependencyInjection.Specification.TestsEdit
Microsoft.Extensions.FileProviders.AbstractionsEdit
Microsoft.Extensions.FileProviders.CompositeEdit
Microsoft.Extensions.FileProviders.PhysicalEdit
Microsoft.Extensions.FileSystemGlobbingEdit
Microsoft.Extensions.Hosting.SystemdEdit
Microsoft.Extensions.Logging.ConfigurationEdit
Microsoft.Extensions.Logging.EventSourceEdit
Microsoft.Extensions.Logging.TraceSourceEdit
Microsoft.Extensions.Options.DataAnnotationsEdit
Microsoft.NET.WebAssembly.ThreadingEdit
Microsoft.Win32.Registry.AccessControlEdit
Microsoft.Win32.SystemEventsEdit
Microsoft.XmlSerializer.GeneratorEdit
System.CodeDomEdit
System.ComponentModel.CompositionEdit
System.ComponentModel.Composition.RegistrationEdit
System.CompositionEdit
System.Composition.AttributedModelEdit
System.Composition.ConventionEdit
System.Composition.HostingEdit
System.Composition.RuntimeEdit
System.Composition.TypedPartsEdit
System.Diagnostics.DiagnosticSourceEdit
System.DirectoryServices.ProtocolsEdit
System.Formats.CborEdit
System.IO.HashingEdit
System.IO.PackagingEdit
System.IO.PipelinesEdit
System.Memory.DataEdit
System.Numerics.TensorsEdit
System.Reflection.ContextEdit
System.Resources.ExtensionsEdit
System.Runtime.Serialization.SchemaEdit
System.Security.Cryptography.CoseEdit
System.Security.Cryptography.PkcsEdit
System.Security.Cryptography.ProtectedDataEdit
System.Security.Cryptography.XmlEdit
System.Security.PermissionsEdit
System.ServiceModel.SyndicationEdit
System.Text.Encodings.WebEdit
System.Threading.AccessControlEdit
System.Threading.RateLimitingEdit
System.Threading.Tasks.DataflowEdit
System.Windows.ExtensionsEdit
✅ (:white_check_mark:) -> reviewed & approved
🕜 (:clock130:) -> under review
cc @lyndaidaii@ericstj@jeffhandley@artl93@MSDN-WhiteKnight
Author:ViktorHofer
Assignees:-
Labels:
area-Meta
Milestone:9.0.0
@ViktorHoferViktorHofer
removed their assignment
Oct 2, 2023
@ViktorHoferViktorHofer
mentioned this pull request
Oct 3, 2023
 Closed

@danmoseley
danmoseley
commented
Oct 3, 2023

Copy link


Copy Markdown

Contributor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
@ViktorHoferViktorHofer
added
the 
help wanted
[up-for-grabs] Good issue for external contributors
label
Oct 3, 2023
@ViktorHofer
ViktorHofer
commented
Oct 3, 2023•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
Presumably we'd be happy to accept community help here? They'd have to share a link to a branch or gist given no perms to push to this
Yes, absolutely. Good idea. I just added the label. We could ask the community to submit PRs against this branch. But unsure if there's any benefit in doing so over just targeting main...
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add package's dependencies section
0799a6f
List related packages with adding short description
and direct URI to nuget.org package.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add additional documentation section
4c5c855
List API Documentation link in Additional Documentation
section.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add main types section
c160342
Liste main types provided by library in Main Types
section.
Does not include internal types which are not exposed out.
Fixdotnet#92228
illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 3, 2023
@illialarka
Add key features and description
a0a0be6
List key features of the library. Add a short
package description.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 3, 2023
 Merged

@tarekghtarekgh
mentioned this pull request
Oct 3, 2023

Closed

illialarka added a commit
to illialarka/runtime
that referenced
this pull request
Oct 4, 2023
@illialarka
Fix PACKAGE.md typo
8110f24
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
@illialarkaillialarka
mentioned this pull request
Oct 4, 2023
 Merged

EnsignPayton added a commit
to EnsignPayton/runtime
that referenced
this pull request
Oct 6, 2023
@EnsignPayton
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
0e235bb
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#92228
@EnsignPaytonEnsignPayton
mentioned this pull request
Oct 6, 2023
 Merged

illialarkaand others
added 3 commits
October 9, 2023 10:56
@illialarka
System.Formats.Cbor package's readme (#93021)
37120cd
* 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
@EnsignPayton@ViktorHofer
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (#93123)
80426d8
* 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>
@ViktorHofer
Fix typo in package readmes
0db2545

This was referenced Oct 13, 2023
 Merged

 Merged

 Merged

@eNeRGy164eNeRGy164
mentioned this pull request
Nov 2, 2023
 Merged


This was referenced Nov 4, 2023
 Merged

 Closed

@eNeRGy164
eNeRGy164
commented
Nov 4, 2023

Copy link


Copy Markdown

Contributor
I learn a lot on APIs I never had a reason to use. 😝
@eNeRGy164eNeRGy164
mentioned this pull request
Nov 5, 2023
 Closed

@eNeRGy164@ViktorHofer
Provide Microsoft.Win32.SystemEvents package readme (#94371)
aacb637
* Provide M.Win32.SystemEvents package readme
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
* Update src/libraries/Microsoft.Win32.SystemEvents/src/PACKAGE.md
---------
Co-authored-by: Viktor Hofer <viktor.hofer@microsoft.com>

This was referenced Nov 9, 2023
 Closed

 Merged

 Merged

 Merged

 Merged

@ghostghost
closed this
Jan 7, 2024
@ghost
ghost
commented
Jan 7, 2024

Copy link


Copy Markdown

Draft Pull Request was automatically closed for 30 days of inactivity. Please let us know if you'd like to reopen it.
@ViktorHoferViktorHofer
reopened this
Jan 8, 2024
@ViktorHofer
ViktorHofer
marked this pull request as ready for review
January 22, 2024 17:42
@ViktorHofer
ViktorHofer
commented
Jan 22, 2024•

edited

Loading

Copy link


Copy Markdown

MemberAuthor
I'm going to merge this now in so that we have these package readmes available for .NET 9 Preview 1. Expect a new PR soon be opened to track the remaining packages readmes.
And now let me pause and thank everyone who participated in this effort, especially @eNeRGy164 who alone submitted 15 package readmes for .NET 9. You are all amazing 🎉 🎉 🎉
ericstj
ericstj
approved these changes
Jan 22, 2024
View reviewed changes
@ericstjericstj
left a comment


Copy link


Copy Markdown

Member
Choose a reason for hiding this comment

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

LGTM - @ViktorHofer let me know this is an aggregate of already reviewed content.
@ViktorHofer
ViktorHofer
merged commit 5aabefa
into
mainJan 22, 2024
@ViktorHofer
ViktorHofer
deleted the

PackageReadmesContinued

branch
January 22, 2024 18:04
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Microsoft.Extensions.Logging.TraceSource package readme update (dotne…
291ae31
…t#92962)
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@illialarka@tmds
Fix PACKAGE.md typo (dotnet#92989)
82683a8
Typo in word 'Defult' fixed to 'Default'.
Fixdotnet#92228
tmds pushed a commit
to tmds/runtime
that referenced
this pull request
Jan 23, 2024
@EnsignPayton@ViktorHofer@tmds
Microsoft.Extensions.FileSystemGlobbing PACKAGE.md (dotnet#93123)
1c5a712
* Microsoft.Extensions.FileSystemGlobbing PACKAGE.md
Fill out details for `Microsoft.Extensions.FileSystemGlobbing` NuGet
package readme
See dotnet#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>
@github-actionsgithub-actionsBot
locked and limited conversation to collaborators
Feb 22, 2024
Sign up for freeto subscribe to this conversation on GitHub.
Already have an account?
Sign in.


Reviewers

@ericstjericstjericstj approved these changes
@tarekghtarekghtarekgh approved these changes

Assignees


No one assigned


Labels

area-Metahelp wanted[up-for-grabs] Good issue for external contributors

Projects


None yet


Milestone

9.0.0

Development

Successfully merging this pull request may close these issues.

8 participants

@ViktorHofer@danmoseley@eNeRGy164@ericstj@tarekgh@illialarka@vcsjones@EnsignPayton