Repository navigation
docs(pages): prepare manual hosting, public API and alternatives for 0.6.0 (#48) - #89
Merged
Merged
Conversation
agustin18
marked this pull request as ready for review
November 21, 2026 05:31
agustin18
added a commit
that referenced
this pull request
Nov 21, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Goal
Prepare a public documentation experience as usable as our existing fastapi-stream-lease site and competitive with the navigation of FastAPI-CacheX, without a PyPI release or involuntary website deployment.
Verified reference designs
Proposed changes
site_urlfor the intended GitHub Pages address (https://agustin18.github.io/fastapi-cache/) and expand navigation with published 0.5.0 API reference and an evidence-bounded alternatives/fit comparison..github/workflows/docs-pages.yml, modeled on fastapi-stream-lease's Pages pipeline, using pinned Zensical and the existing fail-closed link/anchor checker. Nopushtrigger: a merge alone will not deploy.docs/HOSTING_AND_VERSIONING.md: source-of-truth procedure to enable Pages via Actions, manually trigger, verify real URL, mobile navigation, search, PyPI links, and only then advertise the site.mikeintegration is transitional; do not claim to offer immutable versioned pages until a tagged-source snapshot and version navigation work end-to-end.86.doc.md.Approval / acceptance
Do not publish a website, modify PyPI version or tag in this PR. Refs #48 #86 #88.
Security hardening added in follow-up commits (2026-11-21)
contents: readonly and checkout does not persist credentials.actions/configure-pagesruns at that deploy-only permission boundary.github.ref == 'refs/heads/stable'; workflow stays dispatch-only (no push trigger).github-pagesenvironment to deployments fromstableonly. Reviewers/branch policy must be configured before the first manual deploy. A changed workflow on another branch could bypass YAML-only guards.These changes are committed to this draft, but no Pages environment setting or deployment has been changed, and fresh CI/security checks on the final HEAD remain required.