Update repo for Vercel MKdocs compatibility

[Luttik]

Summary by Sourcery

Configure the repository to support automatic Vercel builds of the MkDocs site by adding necessary configuration files and documentation while preserving the GitHub Pages workflow.

New Features:

• Enable Vercel deployment for the MkDocs documentation site

Enhancements:

• Retain the existing GitHub Pages deployment workflow alongside Vercel support

Build:

• Include package.json scripts, requirements.txt, runtime.txt, and vercel.json to configure Python dependencies and Vercel build commands

Documentation:

• Add DEPLOYMENT.md with detailed instructions for Vercel and GitHub Pages deployments

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
auto-optional	❌ Failed (Inspect)			Jul 2, 2025 8:12pm

[sourcery-ai]

Reviewer's Guide

Configure repository for Vercel MkDocs compatibility by adding deployment documentation, defining build scripts and Python dependencies, and supplying Vercel-specific build configuration to ensure proper installation and site generation.

Class diagram for new configuration and build scripts

classDiagram
    class requirements.txt {
        +mkdocs>=1.2.3
        +mkdocs-material>=7.2.6
        +PyYAML>=5.4.1
    }
    class package.json {
        +build(): mkdocs build
        +dev(): mkdocs serve
        +deploy(): mkdocs gh-deploy
    }
    class vercel.json {
        +installCommand: pip install -r requirements.txt
        +buildCommand: mkdocs build
        +outputDirectory: site/
    }
    class runtime.txt {
        +python-<version>
    }
    requirements.txt <.. vercel.json : used by
    package.json <.. vercel.json : referenced by
    runtime.txt <.. vercel.json : used by

Loading

File-Level Changes

Change	Details	Files
Add comprehensive deployment guide	Document Vercel setup and build steps Describe GitHub Pages legacy workflow Include local development and domain configuration instructions List relevant config files and branching strategies	DEPLOYMENT.md
Introduce build scripts for MkDocs	Define "build", "dev", and "deploy" npm scripts using mkdocs commands Add package.json to manage script entrypoints	package.json
Declare Python dependencies	List mkdocs, mkdocs-material, and PyYAML in requirements.txt	requirements.txt
Specify Python runtime	Add runtime.txt to pin the Python version for Vercel builds	runtime.txt
Configure Vercel build pipeline	Set installCommand to install Python dependencies Set buildCommand to run mkdocs build Define outputDirectory for serving static site	vercel.json

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @Luttik - I've reviewed your changes and they look great!

Prompt for AI Agents

Please address the comments from this code review:
## Individual Comments

### Comment 1
<location> `DEPLOYMENT.md:3` </location>
<code_context>
+# Deployment Guide
+
+This repository is configured to support multiple deployment options for the MKdocs documentation site.
+
+## Vercel Deployment (Recommended)
</code_context>

<issue_to_address>
Correct 'MKdocs' to 'MkDocs' for proper capitalization.

Update all occurrences of 'MKdocs' to 'MkDocs' in this document.
</issue_to_address>

<suggested_fix>
<<<<<<< SEARCH
This repository is configured to support multiple deployment options for the MKdocs documentation site.
=======
This repository is configured to support multiple deployment options for the MkDocs documentation site.
>>>>>>> REPLACE

</suggested_fix>

### Comment 2
<location> `DEPLOYMENT.md:16` </location>
<code_context>
+4. Static files will be served from the `site/` directory
+
+### Configuration Files
+- `requirements.txt`: Python dependencies needed for MKdocs
+- `package.json`: Build scripts for Vercel
+- `vercel.json`: Vercel-specific configuration with Python build commands
</code_context>

<issue_to_address>
Correct 'MKdocs' to 'MkDocs' for proper capitalization.

Suggested implementation:

```
- `requirements.txt`: Python dependencies needed for MkDocs

```

```
- `mkdocs.yml`: MkDocs configuration

```
</issue_to_address>

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}

[sourcery-ai]

issue (typo): Correct 'MKdocs' to 'MkDocs' for proper capitalization.

Update all occurrences of 'MKdocs' to 'MkDocs' in this document.

Suggested change

	This repository is configured to support multiple deployment options for the MKdocs documentation site.
	This repository is configured to support multiple deployment options for the MkDocs documentation site.

[sourcery-ai]

issue (typo): Correct 'MKdocs' to 'MkDocs' for proper capitalization.

Suggested implementation:

- `requirements.txt`: Python dependencies needed for MkDocs

- `mkdocs.yml`: MkDocs configuration