docs!: remove MkDocs documentation generation feature#46
Merged
Conversation
Remove all MkDocs-based documentation infrastructure from the project. This simplifies the project by eliminating the documentation build system that was generating GitHub Pages documentation from example files. Changes include: - Remove mkdocs.yml configuration file - Remove scripts/build_docs.py documentation builder script - Remove .github/workflows/docs.yml CI workflow for deploying docs - Remove docs optional dependency group from pyproject.toml (mkdocs-terminal, pygments, pymdown-extensions) - Remove docs-serve and docs-build targets from justfile - Update CLAUDE.md to remove documentation command references The uv.lock file is updated to reflect the removed dependencies. BREAKING CHANGE: The `docs` optional dependency group and related commands (`make docs-serve`, `make docs-build`) are no longer available.
ryoppippi
changed the title
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Pull request overview
This PR removes all MkDocs-based documentation infrastructure from the project, including the documentation generation scripts, GitHub Pages deployment workflow, and all related dependencies. This simplifies the project by eliminating unused documentation tooling.
Key Changes
- Removed MkDocs configuration and documentation build scripts
- Eliminated GitHub Pages deployment workflow
- Cleaned up documentation-related dependencies from
pyproject.tomlanduv.lock
Reviewed changes
Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
mkdocs.yml |
Removed MkDocs configuration file including theme, markdown extensions, and navigation structure |
scripts/build_docs.py |
Removed Python script that converted example files to markdown documentation |
.github/workflows/docs.yml |
Removed GitHub Actions workflow that built and deployed documentation to GitHub Pages |
pyproject.toml |
Removed docs optional dependency group (mkdocs-terminal, pygments, pymdown-extensions) |
justfile |
Removed docs-serve and docs-build command targets |
CLAUDE.md |
Removed documentation command references and the "Updating Documentation" section |
uv.lock |
Removed MkDocs-related packages (mkdocs, mkdocs-terminal, mkdocs-get-deps, ghp-import, markdown, mergedeep, pymdown-extensions, pyyaml-env-tag, watchdog, platformdirs) and updated dependency resolution markers |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
…tation # Conflicts: # CLAUDE.md # justfile
This was referenced Dec 18, 2025
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
2 participants
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.
Summary
Changes
mkdocs.ymlscripts/build_docs.py.github/workflows/docs.ymlpyproject.tomldocsoptional dependency groupjustfiledocs-serveanddocs-buildtargetsCLAUDE.mduv.lockBreaking Changes
docsoptional dependency group is no longer availablemake docs-serveandmake docs-buildcommands are removedTest plan
uv sync --all-extrassucceeds without MkDocs dependenciesSummary by cubic
Removed all MkDocs-based documentation, including mkdocs.yml, the build script, and the GitHub Pages deploy workflow. This simplifies the repo and removes the docs extras and commands (breaking change).
Written for commit a0c7ade. Summary will update automatically on new commits.