Skip to content

docs: add Docusaurus documentation site for docs.mcpproxy.app#197

Merged
Dumbris merged 1 commit into
mainfrom
012-docusaurus-docs-site
Dec 14, 2025
Merged

docs: add Docusaurus documentation site for docs.mcpproxy.app#197
Dumbris merged 1 commit into
mainfrom
012-docusaurus-docs-site

Conversation

@Dumbris
Copy link
Copy Markdown
Member

@Dumbris Dumbris commented Dec 14, 2025

Summary

  • Add Docusaurus 3.x documentation site in website/ directory
  • Create comprehensive documentation (22 pages across 8 sections)
  • Add CI/CD pipeline for automatic deployment to Cloudflare Pages
  • Refactor CLAUDE.md from 28k to 8.5k characters

Documentation Structure

Section Pages
Getting Started Installation, Quick Start
Configuration Config File, Upstream Servers, Environment Variables
CLI Command Reference, Management Commands
API REST API, MCP Protocol
Web UI Dashboard
Features Docker Isolation, OAuth, Code Execution, Security Quarantine, Search & Discovery
Development Architecture, Testing, Building
Contributing Contributing Guide

Features

  • Local search via @easyops-cn/docusaurus-search-local
  • LLMs.txt generation via docusaurus-plugin-llms
  • Dark/light mode with system preference detection
  • Mobile responsive design
  • Edit on GitHub links on all pages

CI/CD

  • Build validation on PRs touching docs/ or website/
  • Automatic deployment to Cloudflare Pages on push to main
  • CLAUDE.md size check workflow (max 25k chars)

Makefile Targets

make docs-build    # Build documentation
make docs-serve    # Serve locally at http://localhost:3000

Test plan

  • npm run build succeeds in website/
  • All 22 pages render correctly
  • Sidebar navigation works
  • Search functionality works
  • Dark/light mode toggle works
  • Mobile responsive layout verified
  • CI workflow passes
  • Cloudflare Pages deployment (requires secrets setup)

🤖 Generated with Claude Code

@cloudflare-workers-and-pages
Copy link
Copy Markdown

cloudflare-workers-and-pages Bot commented Dec 14, 2025

Deploying mcpproxy-docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: c7483d3
Status: ✅  Deploy successful!
Preview URL: https://fc33f3c1.mcpproxy-docs.pages.dev
Branch Preview URL: https://012-docusaurus-docs-site.mcpproxy-docs.pages.dev

View logs

@github-actions
Copy link
Copy Markdown

github-actions Bot commented Dec 14, 2025

📦 Build Artifacts

Workflow Run: View Run
Branch: 012-docusaurus-docs-site

Available Artifacts

  • archive-darwin-amd64 (23 MB)
  • archive-darwin-arm64 (20 MB)
  • archive-linux-amd64 (12 MB)
  • archive-linux-arm64 (11 MB)
  • archive-windows-amd64 (22 MB)
  • archive-windows-arm64 (20 MB)
  • frontend-dist-pr (0 MB)
  • installer-dmg-darwin-amd64 (25 MB)
  • installer-dmg-darwin-arm64 (23 MB)

How to Download

Option 1: GitHub Web UI (easiest)

  1. Go to the workflow run page linked above
  2. Scroll to the bottom "Artifacts" section
  3. Click on the artifact you want to download

Option 2: GitHub CLI

gh run download 20209981090 --repo smart-mcp-proxy/mcpproxy-go

Note: Artifacts expire in 14 days.

- Add Docusaurus 3.x site with classic preset in website/
- Create comprehensive documentation covering:
  - Getting Started (installation, quick start)
  - Configuration (config file, upstream servers, env vars)
  - CLI (command reference, management commands)
  - API (REST API, MCP protocol)
  - Web UI (dashboard)
  - Features (Docker, OAuth, code execution, security, search)
  - Development (architecture, testing, building)
  - Contributing guide
- Add local search via @easyops-cn/docusaurus-search-local
- Add LLMs.txt generation via docusaurus-plugin-llms
- Add GitHub Actions workflow for CI/CD to Cloudflare Pages
- Add CLAUDE.md size check workflow (max 25k chars)
- Refactor CLAUDE.md from 28k to 8.5k chars by moving content to docs
- Update Makefile with docs build/serve targets
- Update release.yml to build docs on release

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
@Dumbris Dumbris force-pushed the 012-docusaurus-docs-site branch from 537b873 to c7483d3 Compare December 14, 2025 15:15
@Dumbris Dumbris merged commit 380057e into main Dec 14, 2025
40 checks passed
@Dumbris Dumbris deleted the 012-docusaurus-docs-site branch December 14, 2025 15:25
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