Doc index: README.md · Phases: roadmap.md
Explicit checklist for calling a release production-ready.
| Area | What shipped |
|---|---|
| PWA | vite-plugin-pwa precaches built assets; editing stays local-first; first visit needs network until shell is cached. |
| Accessibility | Skip link, :focus-visible on controls, role="alert" on preview errors, landmarks (header / main / section), labeled file input and selects. Full WCAG/screen-reader audits = manual follow-up. |
| Dependencies | Dependabot; pnpm audit --audit-level=high in CI; root pnpm.overrides for transitive fixes when needed. |
| Bundle size | Gzip budgets on apps/web/dist/assets via pnpm run budget (CI after build). |
Tick alongside roadmap.md as you go.
-
@inariwrite/coreAPI treated as semver-stable; breaking changes only on major. - Web MVP + CLI (
preview,build,check, config/plugins) documented in README and plugins.md. - MN + EN for all user-visible chrome (
packages/i18n). - LICENSE, CONTRIBUTING, SECURITY, CoC — real contacts (no placeholders).
- CI green on
main; Playwright smoke (pnpm run test:e2e, Chromium) covers load + editor + preview. One-time:pnpm --filter @inariwrite/web exec playwright install chromium. - Changesets (or agreed release notes) for user-facing package changes.
pnpm changesetbefore merging user-visible library changes;pnpm version-packageswhen cutting versions (CONTRIBUTING).- Add
NPM_TOKEN+ a release workflow when publishing to npm.