Skip to content

docs(site): polished 0.5.0 onboarding, safe migration and 0.6.0 roadmap (#48) - #87

Merged
agustin18 merged 27 commits into
stablefrom
docs/48-getting-started-and-060-roadmap
Nov 21, 2026
Merged

agustin18 merged 27 commits into
stablefrom
docs/48-getting-started-and-060-roadmap

Conversation

@agustin18

Copy link
Copy Markdown
Owner

Purpose

Make it immediately obvious how to install from scratch, how to replace fastapi-cache2 safely, which features are published in 0.5.0 and which are only future proposals.

What changes

  • New navigable documentation source in site_docs/ with a modern responsive theme, search, readable light/dark palette, copyable code, navigation cards, accessibility/reduced-motion CSS and clear beginner-vs-migration entry points.
  • Guides for InMemory, standalone Redis, privacy/tenant safety, troubleshooting, Python/redis-py matrix, shipped-vs-proposed feature table, 0.5.0 artifact provenance, and a bounded 0.6.0 plan.
  • Update the previously stale docs/QUICKSTART.md 0.4.1 → published 0.5.0; highlight that vary_headers exists in 0.5.0 but bounded max_entries is not shipped in it.
  • Add a clear top-of-README chooser and a current 0.6.0 section in ROADMAP.md linked to issue roadmap(0.6): bounded InMemory, privacy-safe observability and targeted correctness #86. Keep historical release statuses, MIGRATION/SECURITY/COMPATIBILITY contracts and tagged artifacts unchanged.
  • Add mkdocs.yml (Zensical-compatible) and a read-only docs CI workflow (zensical==0.1.3) to build/verify representative static HTML and upload a 14-day preview artifact. Do not deploy Pages or claim a website is live. No package metadata, runtime code or dependencies modified.
  • Add a Towncrier docs fragment, so the standard PR gate remains fail-closed.

Review and release rules

Refs #48 #86 #53 #54; published 0.5.0 remains immutable.

@agustin18
agustin18 marked this pull request as ready for review November 21, 2026 02:50
@agustin18
agustin18 merged commit 8c079c8 into stable Nov 21, 2026
32 checks passed
agustin18 added a commit that referenced this pull request Nov 21, 2026
…gates (#54)

Squash-rebase PR #85 onto post-#87 stable, preserve exactly five functional/CI files. Refs #54 #86.
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