Repository navigation
Description
2026-11-21 post-merge status: PR #89 MERGED via squash commit
b118890c67c10cc6315af21f03e8633b7c3d703c, with CI, docs checker, CodeQL and changelog green. Source and manual-only Pages workflow are now onstable. Not deployed; public URL unverified. Keep #48 OPEN. Required before activation: Settings → Pages → GitHub Actions source; Settings → Environments →github-pages→ allow deployment fromstableonly (plus optional manual approval); manually rundocs-pages.ymlon reviewedstable; verify actual URL/mobile/search/link resolution; preserve versioned 0.5.0 historical docs when the current site eventually moves to 0.6.0. Merge does not authorize publication. Runbook. Older pre-merge notes below are historical.
2026-11-21 hosting progress: Draft PR #89 prepares a manual-only GitHub Pages workflow, the intended (not verified live)
https://agustin18.github.io/fastapi-cache/URL, 0.5.0 API reference and credible alternatives guide, and published-version documentation strategy. #87 already merged its searchable docs and 464-link build checker. #48 remains open until Pages is configured via GitHub Actions, approved workflow run deployed, exact live URL/mobile/search/links independently checked, and 0.5.0 historical docs preservation strategy confirmed. #89 merge alone must not deploy anything. Hosting plan.
Documentation milestone delivered (2026-11-21): PR #87 MERGED into
stableas8c079c8dbca645f3a2c87cf971c84a6192cbed41after 32/32 green checks. New Zensical responsive/searchable docs source, verified 0.5.0 quickstart/migration and read-only CI preview now include a fail-closed check over every built HTML page, internal link, target file and fragment, with regression tests. #48 remains OPEN solely for explicit public hosting, versioned historical URL strategy and ongoing published-site maintenance. Do not call the website live until a deployment is enabled and independently verified. Earlier draft notes below are historical.
Target: 0.4.0 documentation track; can deliver independently of code
Work already prepared
PR #52 already adds docs/QUICKSTART.md, corrects stale pre-release text and creates the release-status/provenance page. Do not recreate that work in this issue. Wait for its merge (or coordinate changes against its branch).
Remaining scope
- Decide on MkDocs Material or a comparable low-maintenance site and publish versioned docs with clear default stable/current vs historical docs.
- Refactor the long README/MIGRATION/COMPATIBILITY text into navigation: 5-minute quickstart, drop-in migration, Redis vs InMemory, lifecycle, authenticated cache safety, cache key builders, invalidation, TTL/ETag, coders, error semantics, troubleshooting, security/support and API reference.
- Provide runnable source examples for Redis/InMemory and migration with CI smoke checks; include safe auth/tenant separation tests.
- CI builds docs, validates internal links and code snippets, keeps release version claims aligned with PyPI metadata.
- Document unsupported Redis client majors, Redis Cluster namespace clear, experimental Memcached/DynamoDB accurately until support lands.
Done when
Docs are published, navigable, version-aware, and tested; avoid duplicating content already merged by PR #52. The docs site is not a blocker for shipping tested redis-py compatibility in 0.4.0.
Activity
[-]docs: publish versioned getting-started and migration documentation[/-][+]docs: build versioned documentation site after PR #52 quickstart[/+]docs(site): polished 0.5.0 discovery, installation and migration land…
docs(site): polished 0.5.0 discovery, installation and migration land…
docs(site): polished 0.5.0 discovery, installation and migration land…
docs(site): polished 0.5.0 discovery, installation and migration land…
docs(site): polished 0.5.0 discovery, installation and migration land…
docs(site): backend choice, Redis, InMemory, privacy and troubleshoot…
docs(site): backend choice, Redis, InMemory, privacy and troubleshoot…
docs(site): backend choice, Redis, InMemory, privacy and troubleshoot…
docs(site): backend choice, Redis, InMemory, privacy and troubleshoot…
docs(site): backend choice, Redis, InMemory, privacy and troubleshoot…
docs(site): published capability matrix, support, release evidence an…
docs(site): published capability matrix, support, release evidence an…
docs(site): published capability matrix, support, release evidence an…
docs(site): published capability matrix, support, release evidence an…
13 remaining items
docs(site): publish navigable 0.5.0 onboarding and verified links (#87)
docs(pages): add explicit manual Zensical GitHub Pages deployment wit…
docs(nav): reserve canonical Pages URL and add technical API/competit…
docs(0.6): add honest alternatives guide and published 0.5.0 public A…
docs(0.6): add honest alternatives guide and published 0.5.0 public A…
docs(pages): explicit hosting, public verification and immutable-vers…
docs(0.6): connect hosting plan, API alternatives and release marketi…
docs(0.6): connect hosting plan, API alternatives and release marketi…
fix(docs): validate built links under GitHub Pages project base path (#…
test(docs): cover GitHub Pages project URLs and reject cross-base abs…
ci(docs): validate project-relative public paths in preview and manua…
ci(docs): validate project-relative public paths in preview and manua…
docs(pages): manual GitHub Pages hosting, API reference and alternati…
agustin18 commentedon Nov 21, 2026
Hosting handoff / factual status — 2026-11-21
PR #89 is merged on
stableatb118890c; the manual-only.github/workflows/docs-pages.ymlis present. There has been no verified deployment and the proposedhttps://agustin18.github.io/fastapi-cache/is not accepted as live.The currently connected GitHub integration supports reading/modifying repository files/PRs, but does not expose setting Pages build source, editing
github-pagesenvironment deployment branch restrictions, or issuingworkflow_dispatch. Do not bypass those controls with a branch push or a privileged workflow edit.Maintainer-required manual steps (in this order):
github-pages: restrict deployment branches tostableonly; optionally require approval.stableand manually Run workflow. Record run ID, selected ref, deployment URL and environment approval where relevant./getting-started/,/migration/,/reference/api/,/reference/alternatives/and privacy guide; test search, mobile layout, internal paths, PyPI 0.5.0 and GitHub release links. Do not assume domain canonicalization.0.5.0 is still the latest published package. No GitHub Pages website, tag or PyPI release was published by these repository changes.
agustin18 commentedon Nov 21, 2026
Documentation source review update, 2026-11-21: #93 successfully built the 0.5.0-versioned Zensical site (15 pages, 588 internal links verified) while explaining source-merged, unpublished #85. Docs CI. This is CI preview only: Pages has not been activated/deployed and no public URL verified. Required manual
github-pagesenvironmentstablerestriction, Actions source, manual deployment and live site verification remain open. Do not close #48 or announce a website.