Skip to content

Correct stale version and status references in docs#41

Merged
shivamsn97 merged 4 commits into
mainfrom
docs/fix-stale-version-refs
Jul 10, 2026
Merged

Correct stale version and status references in docs#41
shivamsn97 merged 4 commits into
mainfrom
docs/fix-stale-version-refs

Conversation

@shivamsn97

Copy link
Copy Markdown
Member

Sweeps out current-facing version/status text that still read like an old release.

  • README → Status: "early (0.4.x) but real" → "early (0.7.x)"; drop "a first-class plugin system (auth, database) is in progress" — the official auth / database / mail plugins ship today.
  • For-AI-agents guide: "Pyxle is young (0.4.x)" → "(0.7.x)".
  • FAQ: pins to the "0.7.x series" rather than a single patch version (which goes stale every release); test count 2,400+ → 2,500+.
  • Plugins guide: "Status (0.5.0)" → "Status (Phase A — stable since 0.5.0)" so it reads as a since-marker, not a current-version claim, and links the Phase B RFC.

Left as-is (verified not stale): the roadmap's v0.4/v0.5/v0.6/v0.7 history (all correctly marked shipped), genuinely-unshipped "planned" items (JetBrains plugin, shared cross-worker metrics registry), the "three official plugins" count (auth/db/mail), and changelog history. The benchmark page's "0.4.3" version references are being updated separately with the fresh benchmark run.

- README Status: '0.4.x' -> '0.7.x'; drop 'plugin system in progress' — auth/db/mail
  plugins ship today.
- for-ai-agents guide: 'young (0.4.x)' -> '0.7.x'.
- FAQ: pin to the '0.7.x' series (not a single patch that goes stale each release);
  test count 2,400+ -> 2,500+.
- Plugins guide: 'Status (0.5.0)' -> 'Phase A — stable since 0.5.0' so it reads as a
  since-marker, not a current-version claim; link the Phase B RFC.
The scaffold requirements.txt pinned starlette>=0.37,<0.38 — the exact range the
0.7.1 security bump moved off. Because the framework line beside it
(pyxle-framework>=0.7.1) requires starlette>=1.3.1, the generated file was
unsatisfiable and 'pip install -r requirements.txt' failed to resolve on every
fresh project. Pin starlette>=1.3.1,<2.0 to match the framework.
- README docs index: add What's-new sections for 0.6.0 (Markdown output) and
  0.7.0/0.7.1 above 0.5.0, which was presented as the latest release.
- FAQ + SSR architecture doc: both claimed Pyxle has no built-in cache; document
  the built-in page cache ({"data", "revalidate": N} envelope, CACHE directive, SSG).
- Introduction 'What's new': drop the stale '0.5.0 — the depth release' stamp for a
  version-robust summary that also covers the 0.6 Markdown feature.
- CLAUDE.md: the stack renders with React 19, not 18.
Match the scaffold (React 19, Vite 7, @vitejs/plugin-react 5, Node 20.19+) and run
via 'pyxle dev'/'pyxle build' instead of raw vite, so the example matches the
current framework runtime.
@shivamsn97 shivamsn97 merged commit 3f0e359 into main Jul 10, 2026
9 checks passed
@shivamsn97 shivamsn97 deleted the docs/fix-stale-version-refs branch July 10, 2026 18:42
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.

1 participant