Repository navigation
docs: Link the playground from the README - #653
Merged
Merged
Conversation
The README shows two buttons, to the documentation and to the playground, in place of the line that linked the website and the quick start, and a Playground section after the installation. The quick start keeps its link at the end of "How it works". Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
javierbrea
marked this pull request as ready for review
November 12, 2026 13:47
The README is also published on npm, where "This repository holds the packages" did not fit. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2 similar comments
Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
|
|
|
|
3 tasks
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
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
The README, which GitHub and npm both show, links the playground in two places and no longer speaks of "this repository":
Playgroundsection afterInstallationsays what the playground does, and that it opens with the example of "How it works" running on a sample project. That example is the one of the quick start: the same elements and policies, plus astylefile category and without the custommessage.Packagessection opens with "JS Boundaries is published as these packages" instead of "This repository holds the packages of JS Boundaries", which did not fit on npm.The README is copied into the
eslint-plugin-boundariespackage and published to npm, sopackages/eslint-plugin/CHANGELOG.mdgets achoreentry underUnreleased.The playground is not deployed yet, because
masterdoes not include #649. GitHub shows the README ofmaster, and mergingreleaseintomasterdeploys the website, so the links and the playground arrive together.To review: the buttons in the light and dark themes of GitHub. Their label is the default grey of shields.io (
555) and their message uses the accent color of the website (#4c52d8).Agreement
Please check the following boxes after you have read and understood each item.
🤖 Generated with Claude Code