Commit Graph

5 Commits

Author SHA1 Message Date
diegosouzapw
302ea853d5 docs/ux(release): tier marketing, onboarding tour, comparison, and v3.8.0 changelog
Task 8 — Tier 1/2/3 marketing & onboarding UX:
  - README "Why OmniRoute?" enhanced with ASCII 3-tier fallback diagram
    and comparison table vs 9router/LiteLLM/OpenRouter/Portkey
  - docs/marketing/TIERS.md: user-facing tier guide with provider
    classification, strategy notes, and common patterns
  - images/tier-flow-{light,dark}.svg: SVG tier flow diagrams
  - TierFlowDiagram.tsx: responsive SVG diagram (light/dark via next-themes)
  - TierTour.tsx: onboarding step showing tier flow + 3 tier cards
  - onboarding/page.tsx: inserts "How It Works" tier step after Welcome
  - TierCoverageWidget.tsx: home dashboard card showing active provider
    counts per tier with "Add" CTA for empty tiers
  - HomePageClient.tsx: renders TierCoverageWidget before providers section
  - en.json: onboarding.tier namespace (tier1/2/3 labels, subtitle, CTAs)
  - docs/routing/AUTO-COMBO.md: tier weight table and override example

Task 9 — Docs, CHANGELOG, comparison page:
  - CHANGELOG.md: [3.8.0] section documenting all Tasks 1-8
  - docs/releases/v3.8.0.md: detailed release notes with migration guide
  - docs/comparison/OMNIROUTE_VS_ALTERNATIVES.md: 9router/LiteLLM/
    OpenRouter/Portkey comparison matrix
  - docs/architecture/REPOSITORY_MAP.md: new bin/cli/tray/, bin/cli/runtime/,
    skills/ directories
  - docs/ops/RELEASE_CHECKLIST.md: v3.8.0+ checks (tray, SQLite, MCP filter,
    route guard)
2026-05-15 01:04:15 -03:00
diegosouzapw
91b457a802 docs(release): add i18n / doc-links / env-doc checks to RELEASE_CHECKLIST
Wires the new platform-overhaul gates into the Detailed Checklist used by
the release-cut workflow:

  Documentation block:
    npm run check:docs-all   (umbrella over sync, counts, env-doc, deprecated, doc-links)
    npm run check:env-doc-sync   (code ↔ .env.example ↔ ENVIRONMENT.md parity)
    npm run check:doc-links   (no broken internal markdown refs)

  i18n block (replaces stale `scripts/i18n-check.mjs` mention):
    npm run i18n:check   (drift between source docs and .i18n-state.json)
    npm run i18n:check-ui-coverage   (every locale ≥ 80% UI key coverage)
    npm run i18n:sync-ui:dry   (0 missing keys across 40 locales)
    Note about running npm run i18n:run when source English docs change.

These are the same checks newly enforced by the docs-sync-strict and
i18n-ui-coverage CI jobs added in commit acf6b93d.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 20:00:22 -03:00
diegosouzapw
caa262a4c5 feat(docs): add YAML frontmatter to all docs (title/version/lastUpdated)
Every .md under docs/{architecture,guides,reference,frameworks,routing,
security,compression,ops,diagrams} plus docs/README.md now opens with:

  ---
  title: "<inferred from first H1>"
  version: 3.8.0
  lastUpdated: 2026-05-13
  ---

46 files updated (no docs were skipped — none had pre-existing
frontmatter). [slug]/page.tsx already reads frontmatter.version and
frontmatter.lastUpdated via gray-matter and renders a "v3.8.0" pill
plus a "Last updated" caption, so the UI picks these up automatically.

Helper: scripts/docs/add-frontmatter.mjs — idempotent (skips files that
already start with `---`), falls back to a humanized basename when no
leading H1 exists. Excludes docs/i18n/, docs/screenshots/,
docs/superpowers/, docs/diagrams/exported/. Re-runnable safely.

Also regenerated src/app/docs/lib/docs-auto-generated.ts: 44 docs across
8 sections (Architecture / Guides / Reference / Frameworks / Routing /
Security / Compression / Ops), which now includes the 14 docs that were
missing from the v3.7 sidebar (Cloud Agents, Guardrails, Memory, Skills,
Webhooks, Evals, Authz, Agent Protocols, Repository Map, Provider
Reference, Reasoning Replay, Stealth Guide, Tunnels Guide, Electron
Guide).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 18:46:05 -03:00
diegosouzapw
afe2a67c76 Merge FASE 3: docs restructure into 8 subfolders
Reorganizes /docs into 8 subfolders (architecture, guides, reference, frameworks,
routing, security, compression, ops). Resolves two conflicts:

- scripts/docs/gen-provider-reference.ts: combined FASE 1's new __dirname-based
  ROOT (two levels up from scripts/docs/) with FASE 3's new output path
  (docs/reference/PROVIDER_REFERENCE.md).
- scripts/check-env-doc-sync.mjs: deleted by FASE 1, modified by FASE 3; FASE 1's
  delete wins (file is at scripts/check/ now). The FASE 3 intent (point to
  docs/reference/ENVIRONMENT.md) was applied to the strict checker at the new path.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 16:10:49 -03:00
diegosouzapw
b4665fc852 refactor(docs): create 8 subfolders + diagrams/, move 44 docs preserving history
Group docs into intent-based subfolders so the topic each file covers is visible
from the directory layout: architecture/, guides/, reference/, frameworks/,
routing/, security/, compression/, ops/. Adds an empty diagrams/ placeholder
(populated in FASE 4) and a navigable docs/README.md index. Files were moved
with git mv so history is preserved. Internal cross-doc links were rewritten
to point at the new subfolder paths.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-05-13 13:11:53 -03:00