feat: add VitePress documentation site#110
Merged
alukach merged 4 commits intorefactor/cf-workers-proxyfrom Mar 1, 2026
Merged
feat: add VitePress documentation site#110alukach merged 4 commits intorefactor/cf-workers-proxyfrom
alukach merged 4 commits intorefactor/cf-workers-proxyfrom
Conversation
Comprehensive docs site covering authentication, configuration, deployment, architecture, and extension points. Organized into user-facing guide and admin-facing sections. Styled to match docs.source.coop visual identity (IBM Plex Sans, Cascadia Mono headings, warm off-white/teal-gray color scheme). Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add user-facing Endpoints page documenting global (data.source.coop) vs regional (us-west-2.data.source.coop) proxy endpoints, with guidance on when to use each for throughput and egress cost savings. Fix mermaid diagrams using literal \n for line breaks — replace with <br> tags for proper rendering. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Add a narrative section to the homepage explaining the five core motivations: unified interface across backends, native S3 compatibility, metered access for sustainable open data, flexible OIDC auth on both frontend and backend, and multi-runtime deployment. Update feature cards to lead with user-facing value (Unified Interface, Native S3 Compatibility, Metered Access, Flexible Auth) rather than implementation details. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Builds the VitePress site and deploys to GitHub Pages on pushes to main that touch docs/ or the workflow file. Supports manual dispatch via workflow_dispatch. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
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
1 participant
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.
Summary
docs/covering authentication, configuration, deployment, architecture, and extension pointsTest plan
cd docs && pnpm install && pnpm docs:dev— site builds and serves locally🤖 Generated with Claude Code