Skip to content

docs: fix dev script and tidy up README wording#316

Open
Kamsou wants to merge 1 commit into
nuxt:mainfrom
Kamsou:docs/readme-style-cleanup
Open

docs: fix dev script and tidy up README wording#316
Kamsou wants to merge 1 commit into
nuxt:mainfrom
Kamsou:docs/readme-style-cleanup

Conversation

@Kamsou

@Kamsou Kamsou commented Jun 8, 2026

Copy link
Copy Markdown
Contributor

🔗 Linked issue

N/A (small docs-only fixes, no issue needed.)

📚 Description

I was reading through the README and spotted a handful of small things, so I grouped them into one docs PR.

The main one is a broken command: the Development section tells you to run pnpm dev:build, but that script doesn't exist in package.json, copy-pasting it just errors. The actual build script is pnpm build, so I fixed that.

The rest are wording cleanups in line with the docs style guide:

  • swapped subjective words ("easy", "quick") for what the feature actually does
  • turned a few passive sentences back into active voice
  • used "Nuxt Accessibility" consistently in prose, while keeping "Nuxt a11y" where it points at the real DevTools tab label

Plus two cosmetic nits: a double space in one heading and an inconsistent "Scroll-to-element" spelling.

Docs only, no behaviour changes.

@pkg-pr-new

pkg-pr-new Bot commented Jun 8, 2026

Copy link
Copy Markdown

Open in StackBlitz

npm i https://pkg.pr.new/@nuxt/a11y@316

commit: 62c0429

@coderabbitai

coderabbitai Bot commented Jun 8, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9881baba-b884-4b18-a438-547f0efaeddc

📥 Commits

Reviewing files that changed from the base of the PR and between 9f8e04b and 62c0429.

📒 Files selected for processing (1)
  • README.md

📝 Walkthrough

Walkthrough

This PR updates README.md documentation across multiple sections. The changes clarify DevTools UI features including violation card controls, highlighting behavior, and a new dedicated Auto-Scan constant scanning mode subsection. Configuration option descriptions for defaultHighlight, logIssues, and report generation are refined to emphasize timing and behavior details. The development workflow commands section is updated to replace the playground build command with a module and client build command.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title accurately summarizes the main changes: fixing a broken dev script command and tidying up README documentation wording.
Description check ✅ Passed The description is directly related to the changeset, explaining the broken script fix, wording cleanups, and cosmetic corrections made to the README.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant