Package Registry: If a package contains a README.md file, display it in the detail view.

Problem to solve

Packages are each unique and knowing how to use them is a challenge facing engineers. Many packages require or have an option to include a README.md file, but we do now show this in the user interface for package details.

Intended users

User experience goal

To help enable users to utilize a package, display the README.md if available.

Proposal

If a package has a README.md file included with the package, display the README.md file a the bottom of the package detail UI. If a README.md is not available, do not display the UI section devoted to it.

Package Detail w/ README.md

Further details

Different package managers handle README.md differently. This issue is only focused on adding support for a README file if it is already included in the package root directory and called README.md.

The user can not update or edit the readme file through the UI directly. They would need to update the package and publish a new version to the registry.

Permissions and Security

n/a

Documentation

Documentation may be required to explain the circumstances for when a README would be displayed in the package detail.

This may also require we update screenshots of the package detail UI.

Availability & Testing

What does success look like, and how can we measure that?

What is the type of buyer?

Is this a cross-stage feature?

No.