Skip to content

Commit 90cb4da

Browse files
bpamiriclaude
andauthored
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

CLAUDE.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -336,12 +336,16 @@ Strategies: `fixedWindow` (default), `slidingWindow`, `tokenBucket`. Storage: `m
336336

337337
Optional first-party modules are distributed as standalone repositories and installed into `vendor/<name>/`. The framework auto-discovers `vendor/*/package.json` on startup via `PackageLoader.cfc` with per-package error isolation.
338338

339-
Four first-party packages live in standalone repos under `wheels-dev/`, indexed by the `wheels-dev/wheels-packages` registry:
339+
Public author-facing guide: [Packages](web/sites/guides/src/content/docs/v4-0-0-snapshot/digging-deeper/packages.mdx) — manifest fields, mixin targets, lifecycle, service providers, lazy loading, testing, publishing flow. Submission workflow: [wheels-packages/CONTRIBUTING.md](https://github.com/wheels-dev/wheels-packages/blob/main/CONTRIBUTING.md).
340+
341+
Six first-party packages live in standalone repos under `wheels-dev/`, indexed by the `wheels-dev/wheels-packages` registry:
340342

341343
- `wheels-dev/wheels-sentry` — error tracking
342344
- `wheels-dev/wheels-hotwire` — Turbo/Stimulus
343345
- `wheels-dev/wheels-basecoat` — UI components
344346
- `wheels-dev/wheels-legacy-adapter` — 3.x → 4.x compatibility shims
347+
- `wheels-dev/wheels-i18n` — internationalization (JSON or DB-backed translations, pluralization)
348+
- `wheels-dev/wheels-seo-suite` — SEO tooling (meta tags, Open Graph, sitemaps, robots.txt, debug panel)
345349

346350
```
347351
vendor/ # Runtime: framework core + installed packages

0 commit comments

Comments
 (0)