Repository navigation
docs: prepare README for the first stable release - #6
Merged
Merged
Conversation
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Prepare the repository and npm READMEs for the first stable release. Replace the pre-publication notice with stable installation instructions, explain beta-to-stable migration and update behavior, and complete the generation/BANG workflow with polling timeout behavior and the separate BANG generation ID. Group environment settings into a configuration table and keep npm documentation links absolute.
Validation: Prettier and
git diff --checkpassed; repository/package README content matches apart from repository-relative links; the build and npm package dry run passed with the updated README included. Documentation only; no runtime or release workflow changes.