Add MkDocs-based GitHub Pages documentation site#175
Draft
Conversation
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
Member
|
@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. |
Co-authored-by: Ki-Seki <60967965+Ki-Seki@users.noreply.github.com>
Co-authored-by: Ki-Seki <60967965+Ki-Seki@users.noreply.github.com>
Contributor
Author
Replaced the plain HTML/CSS approach with MkDocs (Material theme) in commit The setup is:
The site builds cleanly with |
Copilot
AI
changed the title
Add simple GitHub Pages documentation site
Add MkDocs-based GitHub Pages documentation site
Mar 2, 2026
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
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.
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 navdocs/index.md— Home page with feature overview and design philosophydocs/installation.md— Installation instructions (standard and vLLM variant)docs/quickstart.md— Quick start guide with code examplesdocs/usage.md— Full usage guide covering masked tags, queries, accessing results, and vLLM backendsdocs/api.md— API reference tables and examplesdocs/requirements.txt— Pinsmkdocsandmkdocs-materialfor CI.github/workflows/docs.yml— Installs MkDocs, runsmkdocs build --strict, and deployssite/to GitHub Pages on push tomain(path-filtered todocs/**andmkdocs.yml) and onworkflow_dispatchpyproject.toml—DocumentationURL updated tohttps://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.