Skip to content

Allow documentation corrections without a GitHub account - #11

Merged
plmn95 merged 2 commits into
mainfrom
codex/account-free-doc-suggestions
Sep 23, 2026
Merged

plmn95 merged 2 commits into
mainfrom
codex/account-free-doc-suggestions

Conversation

@plmn95

@plmn95 plmn95 commented Sep 23, 2026

Copy link
Copy Markdown
Owner

Readers can currently edit documentation only through GitHub. This adds an account-free passage editor with review-before-send, draft recovery, and receipt status. A Cloudflare Worker stores suggestions in D1 and a repository-scoped GitHub App creates focused pull requests; stale or formatting-sensitive changes become review issues.

The existing Starlight site, Markdown sources, and Pages deployment remain the publication path. Future bundled manuals link to the matching current page with their version attached; frozen archives are unchanged. The GitHub edit link remains as a secondary option.

Validation:

  • 20 source-mapping, delivery, deduplication, rate-limit, webhook, and GitHub App authentication tests pass.
  • Production builds pass with the editor enabled and disabled; release-mode builds omit the editor and preserve page/version correction links.
  • Existing archive-preservation test passes; Worker bundle and local D1 migration/runtime checks pass.
  • Desktop (1440×1050) and mobile (390×844) browser checks pass for editing, review, failure/retry, receipt, cancellation/draft recovery, and problem reporting. Outbound GitHub and Turnstile responses were mocked for those browser checks.

Cloudflare Worker, D1, Turnstile, GitHub App secrets, and public build variables are configured. The App is installed only on this repository. Main now requires a passing build and one review, with the owner's existing administrator bypass preserved. The public site gains the interface when this PR is merged and Pages deploys.

Live anonymous submission with production Turnstile and a nontechnical-reader usability check remain launch checks. Setup and operational details are in services/suggestions/README.md.

@vercel

vercel Bot commented Sep 23, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
vizard-docs Ready Ready Preview Sep 23, 2026 11:22am UTC

Request Review

@plmn95
plmn95 merged commit ea0f7be into main Sep 23, 2026
3 checks passed

This branch was successfully deployed

1 active deployment
Preview — e6441f4d Deployed Sep 23, 2026 by vercel[bot]
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