Skip to content

Add GitHub Pages documentation site#70

Merged
xiangfu0 merged 1 commit intomainfrom
add-github-pages
Mar 17, 2026
Merged

Add GitHub Pages documentation site#70
xiangfu0 merged 1 commit intomainfrom
add-github-pages

Conversation

@xiangfu0
Copy link
Contributor

Summary

  • Add a modern, responsive single-page documentation site (docs/index.html) with dark theme, featuring: hero section, feature grid, 15 MCP tools reference table, step-by-step quick start guide, tabbed integration examples (Claude Desktop, HTTP API, Docker, Kubernetes), screenshot gallery, and configuration reference
  • Add GitHub Actions workflow (.github/workflows/pages.yml) to deploy the site from docs/ and assets/ directories using actions/deploy-pages

Setup required after merge

  • Go to Settings > Pages and set the source to GitHub Actions
  • The site will be available at https://startreedata.github.io/mcp-pinot/

Test plan

  • Open docs/index.html locally in a browser and verify all sections render correctly
  • Verify responsive layout on mobile viewport
  • Verify navigation links scroll to correct sections
  • Verify tabbed integration section switches between Claude Desktop / HTTP / Docker / K8s
  • Verify screenshot images load correctly (referenced from assets/)
  • After merge, enable GitHub Pages via Actions and confirm deployment

🤖 Generated with Claude Code

Create a modern, responsive single-page documentation site with dark
theme, feature highlights, tools reference, quick start guide, tabbed
integration examples, and screenshot gallery. Add GitHub Actions
workflow to deploy the site from docs/ and assets/ directories.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@xiangfu0 xiangfu0 merged commit e327df2 into main Mar 17, 2026
5 checks passed
@xiangfu0 xiangfu0 deleted the add-github-pages branch March 17, 2026 02:26
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