Add MkDocs-based GitHub Pages documentation site with PR preview

[Copilot]

GIMKit lacked a dedicated documentation page, limiting discoverability and onboarding. Adds a MkDocs documentation site (using the Material theme) deployable via GitHub Pages, with live PR previews for docs changes.

Changes

• mkdocs.yml — MkDocs configuration with Material theme, dark/light mode toggle, code copy buttons, and a structured nav
• docs/index.md — Home page with feature overview and design philosophy
• docs/installation.md — Installation instructions (standard and vLLM variant)
• docs/quickstart.md — Quick start guide with code examples
• docs/usage.md — Full usage guide covering masked tags, queries, accessing results, and vLLM backends
• docs/api.md — API reference tables and examples
• docs/requirements.txt — Pins mkdocs and mkdocs-material for CI
• .github/workflows/docs.yml — Installs MkDocs, runs mkdocs build --strict, and deploys site/ to the gh-pages branch on push to main (path-filtered to docs/** and mkdocs.yml) and on workflow_dispatch, using peaceiris/actions-gh-pages@v4 with keep_files: true so PR preview subdirectories are preserved
• .github/workflows/docs-preview.yml — Builds docs and deploys a live preview to https://sculptai.github.io/GIMKit/pr-preview/pr-{number}/ on every PR touching docs/** or mkdocs.yml; posts a bot comment with the preview URL and cleans up the preview when the PR is closed
• pyproject.toml — Documentation URL updated to https://sculptai.github.io/GIMKit

---

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

[Ki-Seki]

@copilot I mean you should not use complicated doc frameworks, but you have to use frameworks (eg. mkdocs). Choose a proper one and implement it.

[Copilot]

@copilot I mean you should not use complicated doc frameworks, but you have to use frameworks (eg. mkdocs). Choose a proper one and implement it.

Replaced the plain HTML/CSS approach with MkDocs (Material theme) in commit 2bdf744.

The setup is:

• mkdocs.yml — config with Material theme, dark/light mode toggle, code copy buttons
• docs/ — Markdown source files: index.md, installation.md, quickstart.md, usage.md, api.md
• docs/requirements.txt — pins mkdocs and mkdocs-material
• .github/workflows/docs.yml — runs mkdocs build --strict and deploys site/ to GitHub Pages

The site builds cleanly with mkdocs build --strict and site/ is already excluded via .gitignore.

[Ki-Seki]

@copilot make pr branch’s MkDocs docs previewable

[Copilot]

@copilot make pr branch’s MkDocs docs previewable

Done in commit a051894. Here's what was added:

• .github/workflows/docs-preview.yml — triggers on PRs that touch docs/** or mkdocs.yml, builds the docs with mkdocs build --strict, and deploys a live preview via rossjrw/pr-preview-action@v1. When the PR is closed the preview is automatically cleaned up.
• .github/workflows/docs.yml — switched production deployment from GitHub Pages environments to the gh-pages branch (peaceiris/actions-gh-pages@v4 with keep_files: true) so production and PR previews can coexist on the same branch.

Once the repo's GitHub Pages source is set to the gh-pages branch, each PR will get a bot comment with a link to https://sculptai.github.io/GIMKit/pr-preview/pr-{number}/.

[github-actions]

PR Preview Action v1.8.1
🚀 View preview at https://SculptAI.github.io/GIMKit/pr-preview/pr-175/
Built to branch gh-pages at 2026-05-05 09:04 UTC. Preview will be ready when the GitHub Pages deployment is complete.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!