Skip to content

v0.8.0

@diogocoutinho diogocoutinho tagged this 05 May 11:10
Big documentation pass to bring every doc surface in sync with the
shadcn / Radix / `arqel-dev/arqel` meta-package world introduced in
cc34a3c, plus a full internationalization of the docs site.

## VitePress i18n

- Reorganized `apps/docs/` into three locales: `en/` (root, default),
  `pt-BR/` and `es/`. Existing PT-BR content moved into `pt-BR/`.
- Rewrote `.vitepress/config.ts` with `locales: { root, 'pt-BR', es }`,
  per-locale nav / sidebar / UI labels / footer / search translations,
  and a shared `buildSidebar(prefix, t)` helper so the structure stays
  in lockstep across languages.
- Built landing pages (`index.md`) per locale.
- `ignoreDeadLinks: true` while the migration settles — to be tightened
  back to a strict allowlist once internal cross-doc links are audited.
- `pnpm --filter @arqel-dev/docs build` passes (~30 s).

## Top-level docs

- `README.md` rewritten as the EN canonical version, with a stack
  section reflecting Radix UI / shadcn CLI v4 (new-york) / Tailwind v4,
  the new one-line install (`composer require arqel-dev/arqel + php
  artisan arqel:install + migrate + arqel:make-user`), and a summary
  of the monorepo layout. PT-BR and ES mirrors at `README.pt-BR.md`
  / `README.es.md` with the same shape.
- `CHANGELOG.md` `[Unreleased]` populated with everything that landed
  in cc34a3c (shadcn migration, meta-package, auto-installer, demo
  recreate, breaking changes).
- `CONTRIBUTING.md` gained an "incremental builds per package" section
  with `pnpm --filter` examples.
- `AGENTS.md` updated to mention shadcn / Radix and the new install
  flow (this top-level file is the source of truth for LLMs working
  in the monorepo; the `arqel:install` stub is separate).
- `KICKOFF.md`, `CODE_OF_CONDUCT.md`, `SECURITY.md` left untouched
  (historical / standard templates).

## PT-BR docs (source of truth, audited first)

Across `apps/docs/pt-BR/`:

- `guide/installation.md` and `guide/getting-started.md` rewritten
  end-to-end for the new flow.
- `guide/what-is-arqel.md`, `guide/panels.md`, `guide/resources.md`,
  `guide/fields.md`, `guide/tables-forms.md`, `guide/actions.md`,
  `guide/auth.md`, `guide/authentication.md`, `guide/theming.md`,
  `guide/agents.md`, `guide/realtime-collab.md`,
  `guide/release-checklist.md`, `guide/contributing.md`,
  `guide/migration/from-{filament,nova,react-admin}.md` —
  swept for `Base UI` → `Radix UI`, `--color-arqel-*` →
  shadcn vars, internal links re-prefixed `/pt-BR/`.
- `examples/demo-app.md` rewritten to reflect the demo's new
  `arqel:install`-driven recreate flow + Playwright smoke set.
- `reference/php/{core,auth}.md` expanded with the new commands
  (`arqel:make-user`), `HandleArqelInertiaRequests::buildNavigation()`,
  the auth `LoginController` props, and the eight-package surface.
- `reference/typescript/{ui,react,hooks}.md` updated with the shadcn
  primitive set, the `sidebar-07` block, the `splitting: true` story
  for `useTheme()`, and `useNavigation`'s `NavigationItemPayload`.
- `laravel-cloud/deploy-guide.md`, `marketplace/*`, `devtools-extension/*`
  swept for the same mechanical token set.
- `advanced/*` audited — already clean (no edits needed).
- 5-line stubs in `resources/{resource,fields,table,form,actions}.md`
  reported as DOCS-005 follow-up work, not touched here.

## English translations (`apps/docs/en/`)

- 70 files translated from the audited PT-BR sources by parallel
  sub-agents (guide / advanced / examples / reference / resources /
  marketplace / laravel-cloud / devtools-extension).
- Internal links written without locale prefix (EN is the root locale).
- Code blocks, tokens, package / class / method names, anchors and
  VitePress directives left verbatim. Brazilian-flavoured examples
  (`R$ 1.234,56`, BRL currency formatting) preserved when they're the
  point of the example.

## Spanish translations (`apps/docs/es/`)

- 70 files translated from the EN tree by parallel sub-agents (guide
  required a second pass — first batch's writes never persisted; the
  re-run verified each file's first prose sentence is in Spanish).
- Internal links rewritten with `/es/` prefix.
- Same code-block / identifier preservation rules as EN.

## Package SKILL.md updates

- `packages-js/{ui,auth,react,hooks}/SKILL.md` rewritten around shadcn
  + Radix (Button/Input/Card/Field/Sidebar shadcn primitives, the
  `login-04` / `signup-04` blocks consumed by `@arqel-dev/auth`,
  `tsup splitting: true` rationale for `useTheme`, and the new
  `NavigationItemPayload` shape returned by `useNavigation`).
- `packages/{core,auth}/SKILL.md` updated to document the expanded
  `arqel:install` (auto-register provider, publish middleware,
  `vite.config.ts`, `UserResource`, `login-hero.svg`), the new
  `arqel:make-user` command, `HandleArqelInertiaRequests::buildNavigation()`,
  and the auth-controller Inertia props.
- `packages/arqel/SKILL.md` created from scratch describing the
  `type: metapackage` policy, `self.version` requires for the seven
  sub-packages, and the zero-touch install flow.

## PLANNING/ surgical pass

- `00-index.md`, `01-spec-tecnica.md`, `02-arquitetura.md`, `06-api-react.md`,
  `08-fase-1-mvp.md`, `09-fase-2-essenciais.md` — replaced active
  `Base UI` / `@base-ui-components/react` references with their Radix
  equivalents.
- `03-adrs.md` — kept the historical body of ADR-007 intact; added
  a header note "(Update 2026-05: migrated to Radix via shadcn CLI v4
  — see CHANGELOG)".
- Other planning docs (`04-repo-structure`, `05-api-php`,
  `07-roadmap-fases`, `10/11/12`) audited — no edits needed.

## Stats

- 245 files touched, +26,694 / -1,029 lines.
- VitePress build green (~30 s, 0 errors).
- `pnpm --filter @arqel-dev/docs build` validates the full i18n graph.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Signed-off-by: Diogo C. Coutinho <diogo.coutinho.ads@gmail.com>
Assets 2
Loading