Skip to content

Conversation

@remimd
Copy link
Member

@remimd remimd commented Dec 14, 2025

No description provided.

Copy link

Copilot AI left a comment

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 adds MkDocs documentation infrastructure to the project, migrating existing documentation from the documentation/ directory to a new docs/ directory with MkDocs Material theme. The documentation is now hosted at https://python-injection.remimd.dev with automated deployment via GitHub Pages.

Key changes:

  • Adds MkDocs and MkDocs Material dependencies for documentation generation
  • Reorganizes and restructures documentation with improved navigation and formatting
  • Configures automated GitHub Pages deployment workflow

Reviewed changes

Copilot reviewed 29 out of 30 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
uv.lock Adds MkDocs-related dependencies (mkdocs, mkdocs-material, markdown, babel, etc.), updates FastAPI and Ruff versions, adds bench dependencies
pyproject.toml Renames doc group to docs, changes readme path to docs/index.md, adds documentation URL, updates default groups, adds bench dependencies
mkdocs.yml New MkDocs configuration with Material theme, navigation structure, and markdown extensions
docs/*.md New documentation files reorganized into guides, testing, integrations, and root sections
documentation/*.md Removed old documentation files
README.md Simplified to point to the new documentation site
.github/workflows/pages.yml New GitHub Actions workflow for automated MkDocs deployment to GitHub Pages
.github/workflows/*.yml Updated checkout actions from v5 to v6
.github/actions/environment/action.yml Modified to exclude bench group from CI installations
Makefile Added mkdocs command for local documentation serving
docs/CNAME Custom domain configuration for GitHub Pages
Comments suppressed due to low confidence (1)

pyproject.toml:9

  • The bench dependency group is adding "dependency-injector", "injector", and "pytest-benchmark", which are unrelated to the MkDocs documentation feature. These changes should be in a separate PR to maintain clear separation of concerns.
    "tabulate",
    "typer",
    "types-tabulate",

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@remimd remimd merged commit d5afa81 into dev Dec 14, 2025
6 checks passed
@remimd remimd deleted the mkdocs branch December 14, 2025 12:43
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