Commit 90cb4da
docs(docs): refresh packages guide for 4.1 reality (#2281)
* docs(docs): update packages guide for accuracy and 4.1 reality
Closes #2244.
The packages.mdx guide was shipped before several key pieces landed: the
`wheels packages` CLI, the wheels-i18n and wheels-seo-suite conversions
to 4.0 format, and before the `view` mixin-target claim was noticed as
unsupported. This refresh brings the guide into sync with reality.
Substantive changes to `packages.mdx`:
- Remove `view` and `service` from the `provides.mixins` target list —
neither is in PackageLoader's allowlist
(application,dispatch,controller,mapper,model,base,sqlserver,mysql,
postgresql,h2,test plus the specials global/none). Explain that
`controller` already covers views since Wheels views run in the
controller's variables scope.
- Replace the per-method override example's `mixin="view"` with realistic
`mixin="model"` and `mixin="none"` examples.
- Replace "Until Wheels 4.1 lands / gh repo clone as interim" with the
real `wheels packages install|list|search|show|update|remove|registry`
CLI that shipped in #2276.
- Update first-party package list: drop "wheels-i18n is planned for
conversion" (shipped as v2.0.0) and add both wheels-i18n and
wheels-seo-suite to the list of shipped packages.
- Add dedicated sections: Service providers (register/boot lifecycle
with ServiceProviderInterface) and Lazy loading (the `lazy: true`
manifest flag for service-only packages).
- Rewrite the testing section: replace the broken `directory=vendor.*`
URL-param pattern (tracked by #2280) with a BDD spec example and a
caution box pointing at the issue, plus guidance to rely on
per-package CI.
- Rewrite the publishing section with the actual registry submission
checklist and flow (public repo, v<version> tag, file-type allowlist,
10 MB cap, PR title, mirror workflow bot-commits tarball+sha256).
- Add a `lazy` field entry and mention `dependencies` ordering more
explicitly in the manifest reference.
Smaller fixes:
- `glossary.mdx`: "Mixin target" entry no longer lists the non-existent
`view` target.
- `upgrading/3x-to-4x.mdx`: update `mixin="view"` annotation example to
`mixin="model"` / `mixin="none"`.
- `CLAUDE.md`: add a cross-link to the public packages guide and to
wheels-packages/CONTRIBUTING.md, and refresh the first-party package
list to include wheels-i18n and wheels-seo-suite.
No code changes — docs and instructions only.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
* test(docs): refresh packages-index visual baseline
The /packages landing page now renders wheels-i18n and wheels-seo-suite
tiles alongside the original four first-party packages (shipped earlier
today via wheels-dev/wheels-packages#3 and #4, closes #2268 and #2267).
The existing baseline predates those registry entries, so visual-regression
reports 34,529 pixels differ. Diff reviewed — only the two new package
tiles; layout, typography, header, and existing tiles unchanged.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
---------
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>1 parent 0b98ace commit 90cb4da
5 files changed
Lines changed: 137 additions & 51 deletions
File tree
- web
- sites/guides/src/content/docs/v4-0-0-snapshot
- digging-deeper
- upgrading
- tests/visual-baselines
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
336 | 336 | | |
337 | 337 | | |
338 | 338 | | |
339 | | - | |
| 339 | + | |
| 340 | + | |
| 341 | + | |
340 | 342 | | |
341 | 343 | | |
342 | 344 | | |
343 | 345 | | |
344 | 346 | | |
| 347 | + | |
| 348 | + | |
345 | 349 | | |
346 | 350 | | |
347 | 351 | | |
| |||
0 commit comments