docs: Update about-package-readme-files.mdx #1296
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Use file and code format for README references
kenshanta
requested review from
leobalter,
monishcm and
wraithgar
as code owners
wraithgar
reviewed
Sep 25, 2024
...nt/packages-and-modules/contributing-packages-to-the-registry/about-package-readme-files.mdx
Outdated
Show resolved
Hide resolved
wraithgar
reviewed
Sep 25, 2024
| @@ -1,12 +1,12 @@ | |||
| --- | |||
| title: About package README files | |||
| title: About package README.md files | |||
There was a problem hiding this comment.
They do not have to be .md files. The file name can just be README.
The title is probably best to leave as-is.
Prescribing README.md below in the actual copy below is good still though.
There was a problem hiding this comment.
Changed for the sake of consistency.
README files - in my limited experience - are always in markdown format just as package is in JSON format i.e package.json
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Use file and code format for README references