Skip to content

docs: fix typos in entrypoint patterns and UI utility examples - #2598

Merged
PatrykKuniczak merged 1 commit into
wxt-dev:mainfrom
AH64-dll:ai-contrib-docs
Aug 16, 2026
Merged

docs: fix typos in entrypoint patterns and UI utility examples#2598
PatrykKuniczak merged 1 commit into
wxt-dev:mainfrom
AH64-dll:ai-contrib-docs

Conversation

@AH64-dll

Copy link
Copy Markdown
Contributor

wxt-dev/wxt — Submit (WxtSubmit)

Push confirmation

Branch ai-contrib-docs pushed to fork AH64-dll/wxt (origin), tracking set.

Command: git push -u origin ai-contrib-docs

Output:

remote: Create a pull request for 'ai-contrib-docs' on GitHub by visiting:
remote:      https://github.com/AH64-dll/wxt/pull/new/ai-contrib-docs
To https://github.com/AH64-dll/wxt.git
 * [new branch]        ai-contrib-docs -> ai-contrib-docs
branch 'ai-contrib-docs' set up to track 'origin/ai-contrib-docs'.

Branch state at push: ai-contrib-docs @ 60650e3646efe6c3ae8126fa84d4f020b1f966fe (docs: fix typos in entrypoint patterns and UI utility examples), 1 commit ahead of upstream/main (e6678f26), VERIFY.md = PASS (rebase conflict-free, diff --check clean).

PR draft (do NOT run — Main creates the PR)

Exact command

gh pr create --repo wxt-dev/wxt --head AH64-dll:ai-contrib-docs --base main \
  --title "docs: fix typos in entrypoint patterns and UI utility examples" \
  --body "## Summary

Fix three confirmed typo/rendering defects in the docs (markdown-only, zero runtime risk):

1. \`docs/guide/essentials/entrypoints.md\` — stray backtick inside the Side Panel pattern table rows (\`'{name}.html\` '\` and \`'{name}.html\` '\` in the pattern column). The \`EntrypointPatterns\` Vue component renders \`pattern[1]\` verbatim inside \`<code>\`, so the literal backtick is displayed on the live docs site. The adjacent Sandbox rows already use the backtick-free style.
2. \`docs/guide/essentials/content-scripts.md\` — missing space before the opening backtick of \`createShadowRootUi\` in the UI utility list, which opened an inline-code span that swallowed the rest of the paragraph in rendered markdown. Adjacent list rows use \`- \` + backtick style.
3. \`docs/guide/resources/faq.md\`\`create\`ShadowRoot\`Ui\` inside three fenced code examples rendered literally as invalid TypeScript (unterminated template-literal token followed by \`Ui\`). Corrected to the real exported API \`createShadowRootUi\`, matching the same file's lines 31/169.

## Type

Docs typo/rendering fix. No runtime code, no dependency changes, no formatting churn, no behavior changes. Additive-only change per contribution scope.

## Testing

- 3 files changed, 6 insertions(+), 6 deletions(-): \`docs/guide/essentials/content-scripts.md\`, \`docs/guide/essentials/entrypoints.md\`, \`docs/guide/resources/faq.md\`
- \`git diff --check\` clean (pre- and post-rebase against \`upstream/main\`)
- Code-fence balance and VitePress directive balance verified in all three changed files
- Cross-checked against implementation: \`createShadowRootUi\` is the exported API at \`packages/wxt/src/utils/content-script-ui/shadow-root.ts:20\`; the sidepanel patterns match \`PATH_GLOB_TO_TYPE_MAP\` at \`packages/wxt/src/core/utils/building/find-entrypoints.ts:455-456\`
- Live-render impact confirmed: \`docs/.vitepress/components/EntrypointPatterns.vue:35\` renders \`pattern[1]\` verbatim in \`<code>/{{ pattern[1] }}</code>\`
- No residual bad patterns remain in \`docs/\` (grep for \`create\`ShadowRoot\`Ui\` and the stray-backtick pattern: zero matches)
- Full test suite not run: markdown-only change; per project guidance no \`pnpm install\` for docs-only edits

## AI disclosure

**AI disclosure:** This contribution was prepared with the assistance of AI tools and was human-reviewed before submission. The author understands and can explain the change."

Full PR body (for reference / re-use)

Title: docs: fix typos in entrypoint patterns and UI utility examples

Body:


Summary

Fix three confirmed typo/rendering defects in the docs (markdown-only, zero runtime risk):

  1. docs/guide/essentials/entrypoints.md — stray backtick inside the Side Panel pattern table rows ('{name}.html ' and '{name}.html ' in the pattern column). The EntrypointPatterns Vue component renders pattern[1] verbatim inside <code>, so the literal backtick is displayed on the live docs site. The adjacent Sandbox rows already use the backtick-free style.
  2. docs/guide/essentials/content-scripts.md — missing space before the opening backtick of createShadowRootUi in the UI utility list, which opened an inline-code span that swallowed the rest of the paragraph in rendered markdown. Adjacent list rows use - + backtick style.
  3. docs/guide/resources/faq.mdcreateShadowRootUi inside three fenced code examples rendered literally as invalid TypeScript (unterminated template-literal token followed by Ui). Corrected to the real exported API createShadowRootUi, matching the same file's lines 31/169.

Type

Docs typo/rendering fix. No runtime code, no dependency changes, no formatting churn, no behavior changes. Additive-only change per contribution scope.

Testing

  • 3 files changed, 6 insertions(+), 6 deletions(-): docs/guide/essentials/content-scripts.md, docs/guide/essentials/entrypoints.md, docs/guide/resources/faq.md
  • git diff --check clean (pre- and post-rebase against upstream/main)
  • Code-fence balance and VitePress directive balance verified in all three changed files
  • Cross-checked against implementation: createShadowRootUi is the exported API at packages/wxt/src/utils/content-script-ui/shadow-root.ts:20; the sidepanel patterns match PATH_GLOB_TO_TYPE_MAP at packages/wxt/src/core/utils/building/find-entrypoints.ts:455-456
  • Live-render impact confirmed: docs/.vitepress/components/EntrypointPatterns.vue:35 renders pattern[1] verbatim in <code>/{{ pattern[1] }}</code>
  • No residual bad patterns remain in docs/ (grep for createShadowRootUi and the stray-backtick pattern: zero matches)
  • Full test suite not run: markdown-only change; per project guidance no pnpm install for docs-only edits

AI disclosure

AI disclosure: This contribution was prepared with the assistance of AI tools and was human-reviewed before submission. The author understands and can explain the change.


DELIVERABLE: branch ai-contrib-docs pushed to origin (AH64-dll/wxt) — * [new branch] ai-contrib-docs -> ai-contrib-docs, tracking set, @ 60650e36 (1 ahead of upstream/main e6678f26, VERIFY.md PASS). PR drafted above: title docs: fix typos in entrypoint patterns and UI utility examples, full body with Summary / Type / Testing / AI disclosure, exact gh pr create --repo wxt-dev/wxt --head AH64-dll:ai-contrib-docs --base main --title "..." --body "..." command provided. PR NOT created — Main creates it after the gate.

@netlify

netlify Bot commented Aug 16, 2026

Copy link
Copy Markdown

Deploy Preview for creative-fairy-df92c4 ready!

Name Link
🔨 Latest commit 60650e3
🔍 Latest deploy log https://app.netlify.com/projects/creative-fairy-df92c4/deploys/6a81684b79bd2d000823ea0e
😎 Deploy Preview https://deploy-preview-2598--creative-fairy-df92c4.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.
🤖 Make changes Run an agent on this branch

To edit notification comments on pull requests, go to your Netlify project configuration.

@PatrykKuniczak PatrykKuniczak left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Nice catch 😄

@pkg-pr-new

pkg-pr-new Bot commented Aug 16, 2026

Copy link
Copy Markdown

Open in StackBlitz

@wxt-dev/analytics

npm i https://pkg.pr.new/@wxt-dev/analytics@2598

@wxt-dev/auto-icons

npm i https://pkg.pr.new/@wxt-dev/auto-icons@2598

@wxt-dev/browser

npm i https://pkg.pr.new/@wxt-dev/browser@2598

@wxt-dev/i18n

npm i https://pkg.pr.new/@wxt-dev/i18n@2598

@wxt-dev/is-background

npm i https://pkg.pr.new/@wxt-dev/is-background@2598

@wxt-dev/module-react

npm i https://pkg.pr.new/@wxt-dev/module-react@2598

@wxt-dev/module-solid

npm i https://pkg.pr.new/@wxt-dev/module-solid@2598

@wxt-dev/module-svelte

npm i https://pkg.pr.new/@wxt-dev/module-svelte@2598

@wxt-dev/module-vue

npm i https://pkg.pr.new/@wxt-dev/module-vue@2598

@wxt-dev/runner

npm i https://pkg.pr.new/@wxt-dev/runner@2598

@wxt-dev/storage

npm i https://pkg.pr.new/@wxt-dev/storage@2598

@wxt-dev/unocss

npm i https://pkg.pr.new/@wxt-dev/unocss@2598

@wxt-dev/webextension-polyfill

npm i https://pkg.pr.new/@wxt-dev/webextension-polyfill@2598

wxt

npm i https://pkg.pr.new/wxt@2598

commit: 60650e3

@PatrykKuniczak
PatrykKuniczak enabled auto-merge (squash) August 16, 2026 07:47
@codecov

codecov Bot commented Aug 16, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 79.61%. Comparing base (e6678f2) to head (60650e3).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #2598      +/-   ##
==========================================
+ Coverage   79.39%   79.61%   +0.22%     
==========================================
  Files         135      135              
  Lines        4048     4048              
  Branches      943      943              
==========================================
+ Hits         3214     3223       +9     
+ Misses        737      730       -7     
+ Partials       97       95       -2     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@PatrykKuniczak
PatrykKuniczak merged commit 2a98753 into wxt-dev:main Aug 16, 2026
20 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Thanks for helping make WXT better!

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.

2 participants