Skip to content

Add MkDocs-based GitHub Pages documentation site#175

Draft
Copilot wants to merge 4 commits intomainfrom
copilot/add-github-page-docs
Draft

Add MkDocs-based GitHub Pages documentation site#175
Copilot wants to merge 4 commits intomainfrom
copilot/add-github-page-docs

Conversation

Copy link
Contributor

Copilot AI commented Mar 2, 2026

GIMKit lacked a dedicated documentation page, limiting discoverability and onboarding. Adds a MkDocs documentation site (using the Material theme) deployable via GitHub Pages.

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 GitHub Pages on push to main (path-filtered to docs/** and mkdocs.yml) and on workflow_dispatch
  • pyproject.tomlDocumentation 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.

Co-authored-by: Ki-Seki <60967965+Ki-Seki@users.noreply.github.com>
Copilot AI changed the title [WIP] Add GitHub page documentation for GIMKit tool Add simple GitHub Pages documentation site Mar 2, 2026
@Ki-Seki
Copy link
Member

Ki-Seki commented Mar 2, 2026

@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 AI and others added 2 commits March 2, 2026 03:29
Co-authored-by: Ki-Seki <60967965+Ki-Seki@users.noreply.github.com>
Co-authored-by: Ki-Seki <60967965+Ki-Seki@users.noreply.github.com>
Copy link
Contributor Author

Copilot AI commented Mar 2, 2026

@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.

Copilot AI changed the title Add simple GitHub Pages documentation site Add MkDocs-based GitHub Pages documentation site Mar 2, 2026
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.

2 participants