Skip to content

docs!: remove MkDocs documentation generation feature - #46

Merged
ryoppippi merged 2 commits into
mainfrom
remove-mkdocs-documentation
Dec 18, 2025
Merged

docs!: remove MkDocs documentation generation feature#46
ryoppippi merged 2 commits into
mainfrom
remove-mkdocs-documentation

Conversation

@ryoppippi

@ryoppippiryoppippi commented Dec 18, 2025

Copy link
Copy Markdown
Contributor

Summary

  • Remove MkDocs-based documentation infrastructure from the project
  • Eliminate GitHub Pages deployment workflow and all related configuration
  • Simplify project by removing documentation build dependencies

Changes

FileAction
mkdocs.ymlRemoved
scripts/build_docs.pyRemoved
.github/workflows/docs.ymlRemoved
pyproject.tomlRemoved docs optional dependency group
justfileRemoved docs-serve and docs-build targets
CLAUDE.mdRemoved documentation command references
uv.lockUpdated (removed mkdocs dependencies)

Breaking Changes

  • The docs optional dependency group is no longer available
  • make docs-serve and make docs-build commands are removed

Test plan

  • Verify uv sync --all-extras succeeds without MkDocs dependencies
  • Verify CI workflows pass without docs workflow
  • Verify no broken references to removed files

Summary 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).

  • Migration
    • Remove any use of the docs extra from installs and CI.
    • Replace or remove uses of the docs-serve and docs-build commands.
    • Update or remove links to the GitHub Pages docs site (no longer deployed).

Written for commit a0c7ade. Summary will update automatically on new commits.

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.
CopilotAI review requested due to automatic review settings December 18, 2025 13:17
@ryoppippiryoppippi changed the title chore!: remove MkDocs documentation generation featuredocs!: remove MkDocs documentation generation featureDec 18, 2025

@cubic-dev-aicubic-dev-aiBot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No issues found across 7 files

CopilotAI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.toml and uv.lock

Reviewed changes

Copilot reviewed 6 out of 7 changed files in this pull request and generated no comments.

Show a summary per file
FileDescription
mkdocs.ymlRemoved MkDocs configuration file including theme, markdown extensions, and navigation structure
scripts/build_docs.pyRemoved Python script that converted example files to markdown documentation
.github/workflows/docs.ymlRemoved GitHub Actions workflow that built and deployed documentation to GitHub Pages
pyproject.tomlRemoved docs optional dependency group (mkdocs-terminal, pygments, pymdown-extensions)
justfileRemoved docs-serve and docs-build command targets
CLAUDE.mdRemoved documentation command references and the "Updating Documentation" section
uv.lockRemoved 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.

@glebedelglebedel left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@ryoppippi
ryoppippi merged commit 947863e into mainDec 18, 2025
6 checks passed
@ryoppippi
ryoppippi deleted the remove-mkdocs-documentation branch December 18, 2025 14:48
Sign up for freeto 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.

3 participants

@ryoppippi@glebedel