Improve packages docs - document root package json and public API knowledge #31598
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
|
Size Change: -59 B (0%) Total Size: 1.31 MB
ℹ️ View Unchanged
|
gziolo
reviewed
May 7, 2021
packages/README.md
Outdated
| @@ -115,6 +117,10 @@ npm install glob --save-dev | |||
|
|
|||
| This commands adds the latest version of `glob` as a development dependency to the `package.json` file. It has to be executed from the root of the project. | |||
|
|
|||
| ## Maintaining a Public API | |||
There was a problem hiding this comment.
It looks like you could put this paragraph under the next section which is also about API 😄
We can also create a connection with the next paragraph but putting emphasis that generated API helps to find out what's actually becomes Public API.
gziolo
approved these changes
May 7, 2021
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.
Description
@gziolo provided some excellent advice around:
package.json.This PR improves the documentation to capture this knowledge.
How has this been tested?
Reading words and checking they are aligned with @gziolo and his thoughts on packages.
Screenshots
Types of changes
New feature (non-breaking change which adds functionality)
Checklist:
*.native.jsfiles for terms that need renaming or removal).