Skip to content

docs: prepare release - #34

Merged
userquin merged 1 commit into
mainfrom
userquin/docs-prepare-release
Oct 17, 2026
Merged

userquin merged 1 commit into
mainfrom
userquin/docs-prepare-release

Conversation

@userquin

@userquin userquin commented Oct 17, 2026 •

Copy link
Copy Markdown
Member

Description

This PR includes:

  • update workbox packages to 8.0.13
  • expose vite conf subpackages exports at types
  • updates all readme files: netlify docs links, Anthony Sponsor and install sections

Linked Issues

Additional Context

I'm going to update the docs at netlify, maybe we need more changes: will go to another PR

Summary by CodeRabbit

  • Documentation
    • Updated documentation links across the project and package guides, including the Workbox reference.
    • Clarified configuration options, supported config filenames, loading order, and how inline settings interact with external configuration.
    • Updated core package installation examples to use development-dependency commands.
    • Expanded generated API documentation to cover additional configuration topics.
    • Added documentation and project badges, a sponsors image, and improved heading hierarchy in package guides.

@github-actions github-actions Bot added documentation Improvements or additions to documentation pkg: core Changes affecting the core package pkg: vite Changes affecting the vite build package pkg: inspector Changes affecting the inspector package pkg: types Changes affecting the types package 📦 dependencies Dependency updates labels Oct 17, 2026
@coderabbitai

coderabbitai Bot commented Oct 17, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: fbc4a08f-8060-4015-ad12-327a69e103f7
📥 Commits

Reviewing files that changed from the base of the PR and between d513072 and adfc317.

⛔ Files ignored due to path filters: 1
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing: 9
  • README.md
  • packages/core/README.md
  • packages/core/src/config.ts
  • packages/inspector/README.md
  • packages/types/README.md
  • packages/types/gen.mts
  • packages/vite/README.md
  • packages/vite/src/node/config/index.ts
  • pnpm-workspace.yaml

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.

📝 Walkthrough

This change updates project and package documentation links, README content and installation examples, adds configuration API comments and TypeDoc entry points, and raises three Workbox catalog versions from ^8.0.12 to ^8.0.13.

Changes: Documentation updates

Layer / File(s) Summary
README links and package guidance
README.md, packages/core/README.md, packages/inspector/README.md, packages/types/README.md, packages/vite/README.md
Updates documentation links and badges across the READMEs. The inspector README changes three heading levels, the types README adds a sponsors image, and the core installation examples use development-dependency flags.
Configuration API documentation
packages/core/src/config.ts, packages/vite/src/node/config/index.ts, packages/types/gen.mts
Adds comments for configuration loading and resolution functions and definePwaConfig. Adds the Vite configuration index and types modules to TypeDoc entry points.

Workbox catalog update

Layer / File(s) Summary
Workbox dependency versions
pnpm-workspace.yaml
Updates the catalog versions for @vite-pwa/workbox-build, @vite-pwa/workbox-window, and @vite-pwa/workbox-swkit from ^8.0.12 to ^8.0.13.

Priority: ⬇️ Low

Estimated code review effort: 2 (Simple) | ~8 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to adfc3

The PR updates release documentation and Workbox versions. The documented configuration behavior matches the implementation, and no material user-facing or operational risk remains.

Pre-merge checks: Passed 4 · Failed 1

Failed Failed checks: 1 warning

Check name Status Explanation Resolution
Docstring Coverage Warning Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 3 files. (6 skipped: 6… Write docstrings for the functions missing them to satisfy the coverage threshold.
Passed Passed checks: 4 passed
Check name Status Explanation
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.
Title check Passed The title uses the conventional docs: prefix and accurately summarizes the documentation and release-preparation changes, although it does not mention the Workbox or type-export updates.
Description check Passed The description summarizes the main changes and includes the required Description, Linked Issues, and Additional Context sections. The Linked Issues section is empty, and the description does not expl…
Full details: Description check

Explanation

The description summarizes the main changes and includes the required Description, Linked Issues, and Additional Context sections. The Linked Issues section is empty, and the description does not explicitly state whether relevant tests were added or unnecessary.

Full details: Docstring Coverage

Explanation

Docstring coverage is 66.67% which is insufficient. The required threshold is 80.00%. Docstring coverage is scoped to functions touched by this diff. Analyzed 6 functions across 3 files. (6 skipped: 6 unsupported.)

Resolution

Write docstrings for the functions missing them to satisfy the coverage threshold.

  • Fix all pre-merge checks with AI
✨ Finishing Touches: 💡 1
📝 Generate docstrings: 💡
  • Commit to this branch
  • Create a new PR
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

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.

@pkg-pr-new

pkg-pr-new Bot commented Oct 17, 2026

Copy link
Copy Markdown

Open in StackBlitz

pnpm add https://pkg.pr.new/@unplugin-pwa/core@34
pnpm add https://pkg.pr.new/@unplugin-pwa/inspector@34
pnpm add https://pkg.pr.new/@unplugin-pwa/types@34
pnpm add https://pkg.pr.new/@unplugin-pwa/vite@34

commit: adfc317

@userquin
userquin merged commit eb402e0 into main Oct 17, 2026
12 checks passed
@userquin
userquin deleted the userquin/docs-prepare-release branch October 17, 2026 22:33
@github-actions github-actions Bot mentioned this pull request Oct 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

📦 dependencies Dependency updates documentation Improvements or additions to documentation pkg: core Changes affecting the core package pkg: inspector Changes affecting the inspector package pkg: types Changes affecting the types package pkg: vite Changes affecting the vite build package

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant