Skip to content

docs: Link the playground from the README - #653

Merged
javierbrea merged 3 commits into
releasefrom
docs/readme-playground
Nov 12, 2026
Merged

javierbrea merged 3 commits into
releasefrom
docs/readme-playground

Conversation

@javierbrea

@javierbrea javierbrea commented Nov 12, 2026 •

Copy link
Copy Markdown
Owner

Description

The README, which GitHub and npm both show, links the playground in two places and no longer speaks of "this repository":

  • Two buttons under the introduction, to the documentation and to the playground, replace the line that linked the website and the quick start. The quick start keeps its link at the end of "How it works".
  • A Playground section after Installation says 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 a style file category and without the custom message.
  • The Packages section 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-boundaries package and published to npm, so packages/eslint-plugin/CHANGELOG.md gets a chore entry under Unreleased.

The playground is not deployed yet, because master does not include #649. GitHub shows the README of master, and merging release into master deploys 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

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 javierbrea added scope: documentation Improvements or additions to documentation type: task A general task or action item to be completed labels Nov 12, 2026
@javierbrea javierbrea self-assigned this Nov 12, 2026
@javierbrea
javierbrea marked this pull request as ready for review November 12, 2026 13:47

@devin-ai-integration devin-ai-integration Bot left a comment •

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Note

Newer findings are available below. Devin Review posted a newer report on this PR, in addition to the findings presented here.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Devin Review

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>
devin-ai-integration[bot]

This comment was marked as resolved.

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — docs/readme-playground into release

2 similar comments
@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — docs/readme-playground into release

@coveralls

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — docs/readme-playground into release

@coveralls

coveralls commented Nov 12, 2026 •

Copy link
Copy Markdown

Coverage Status

coverage: 100.0%. remained the same — docs/readme-playground into release

Co-authored-by: devin-ai-integration[bot] <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed for 'javierbrea_eslint-plugin-boundaries_elements'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed for 'javierbrea_eslint-plugin-boundaries_config'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@sonarqubecloud

Copy link
Copy Markdown

Quality Gate Passed Quality Gate passed for 'javierbrea_eslint-plugin-boundaries_policies'

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@sonarqubecloud

Copy link
Copy Markdown

@javierbrea
javierbrea merged commit 83b9de8 into release Nov 12, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

scope: documentation Improvements or additions to documentation type: task A general task or action item to be completed

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants