Skip to content

docs(docs): rewrite for v0.3.0 MVP + dark-first palette#178

Merged
Pratiyush merged 3 commits intomasterfrom
docs/rewrite-v0.3.0
Apr 19, 2026
Merged

docs(docs): rewrite for v0.3.0 MVP + dark-first palette#178
Pratiyush merged 3 commits intomasterfrom
docs/rewrite-v0.3.0

Conversation

@Pratiyush
Copy link
Copy Markdown
Owner

Summary

  • v0.3.0 shipped — docs site needed to stop reading like pre-alpha.
  • New home page hero leads with what ships today (auth, orgs, keys + translations + ICU, FTS, import/export, API keys/PATs). BYOK AI moves into a "coming in v0.4.0" section.
  • New Quickstart page: 10-minute path from docker compose up to first exported i18next JSON.
  • Dark palette by default (developer-docs muscle memory).
  • Stale-content fixes across self-hosting/runtime-profiles.md, index.md, webapp/src/i18n/en.json.

Closes

Preview

  • Jekyll/Pages rebuild on merge. Live site: https://pratiyush.github.io/translately/
  • Key pages to eyeball after merge:
    • / — new hero + capability grid
    • /quickstart/ — new
    • /self-hosting/runtime-profiles/ — unsticks Phase 0 claims
  • Light palette still reachable via just-the-docs toggle (session-scoped).

Scope guard

  • No product code change beyond two unused i18n strings (app.phase.current, app.status.prealpha) — those strings are defined in en.json but not rendered anywhere yet; this is pure hygiene. Webapp tests still 104/104.
  • No new API endpoint, no ADR, no migration.

Test plan

  • pnpm --filter webapp typecheck — clean
  • pnpm --filter webapp lint — clean
  • pnpm --filter webapp test — 104/104 green
  • bash scripts/gen-llms-txt.sh clean
  • CI green (lychee, CodeQL, analyze, pages build)
  • Visual check on the live preview (light + dark, home, quickstart)

Docs surfaces per CLAUDE.md rule #10

  • Product — home rewrite, Quickstart added, llms.txt index refreshed
  • Architecture — no structural or ADR change.
  • API — no surface change.
  • Self-hosting — runtime-profiles unstuck
  • LLM-ingestible — both llms.txt and llms-full.txt regenerated

Pre-merge

  • GPG-signed commits
  • Conventional Commits PR title
  • One intent: docs rewrite for MVP shipped
  • Light + dark + keyboard + a11y — palette is dark-first but just-the-docs provides the full prefers-color-scheme + manual-toggle pair
  • I have read and accept the Contributor License Agreement.

Closes #177

The docs site still read like pre-alpha — home lead with BYOK AI (Phase 4,
not shipped), the webapp i18n strings said "Phase 0 — Bootstrap / Pre-alpha",
self-hosting/runtime-profiles.md claimed "Phase 0 has no entities or
migrations yet". None of that is true after today's v0.3.0 tag.

Changes:
- docs/index.md — new hero narrative leading with what ships today in
  v0.3.0 (auth, orgs, keys + translations + ICU, FTS, import/export, API
  keys/PATs). Moves BYOK AI into a "coming in v0.4.0" section. New capability
  grid. Roadmap table marks Phases 0–3 as ✅ shipped.
- docs/quickstart.md — new 10-minute path from `docker compose up` to
  exported i18next JSON. Walks sign-up → verify → org → project → import →
  edit → export. Troubleshooting table for the four most common snags.
- docs/_config.yml — switch `color_scheme` to `dark` (just-the-docs
  built-in). Aligns with developer-docs muscle memory (Stripe, Cloudflare,
  Tailwind all default dark). Description updated to reflect v0.3.0.
- docs/self-hosting/runtime-profiles.md — unstick Phase 0 references;
  enumerate the four Flyway migrations that actually exist on master; bump
  the boot-time log-line version to 0.3.0.
- docs/llms.txt — add Quickstart + home + all Phase 1–3 API/product pages
  that were missing from the hand-maintained index. Update the blurb at the
  top to reflect v0.3.0 scope.
- docs/llms-full.txt — regenerated via scripts/gen-llms-txt.sh (picks up
  the new home + quickstart content).
- webapp/src/i18n/en.json — `app.phase.current` "Phase 0 — Bootstrap" →
  "Phase 3 — MVP shipped (v0.3.0)"; `app.status.prealpha` "Pre-alpha" →
  "Prerelease (0.x)". Strings are not currently rendered anywhere in the
  UI; this is purely hygiene so the next page that surfaces them reads true.

Webapp lint + typecheck + 104/104 tests green.

No new env vars, no new compose services, no API surface change, no new
ADR. This is pure docs + copy + visual palette.

Closes #177
@Pratiyush Pratiyush merged commit 8b0c38e into master Apr 19, 2026
8 checks passed
@Pratiyush Pratiyush deleted the docs/rewrite-v0.3.0 branch April 19, 2026 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: rewrite for v0.3.0 (MVP shipped) + Stripe-docs-style visual polish

1 participant