Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Dec 2, 2025

Adds automated MkDocs documentation deployment to GitHub Pages via GitHub Actions.

Changes

  • .github/workflows/docs.yml - New workflow triggered on docs/mkdocs.yml changes to main, plus manual dispatch. Installs all required plugins (material, mermaid2, awesome-pages, git-revision-date-localized), builds with mkdocs build --clean, deploys via actions/deploy-pages@v4

  • docs/index.md - Homepage with project overview, navigation links, and quick start

  • mkdocs.yml - Fixed nav paths from docs/FILE.md to FILE.md (relative to docs_dir). Added System Design Interviews section

Post-merge setup

Enable GitHub Pages in repo settings → Pages → Source: GitHub Actions

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • unpkg.com
    • Triggering command: /home/REDACTED/.local/bin/mkdocs mkdocs build --clean (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Original prompt

This section details on the original issue you should resolve

<issue_title>Publish mkdocs doc site to gh pages</issue_title>
<issue_description>Can you publish the mkdocs site to this repos gh pages with an action.</issue_description>

Comments on the Issue (you are @copilot in this section)


✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: ianlintner <500914+ianlintner@users.noreply.github.com>
@ianlintner ianlintner marked this pull request as ready for review December 2, 2025 17:26
@ianlintner ianlintner merged commit 3cbdd78 into main Dec 2, 2025
0 of 7 checks passed
@ianlintner ianlintner deleted the copilot/publish-mkdocs-to-gh-pages branch December 2, 2025 17:26
Copilot AI restored the copilot/publish-mkdocs-to-gh-pages branch December 2, 2025 17:26
Copilot AI changed the title [WIP] Publish mkdocs site to GitHub Pages Add GitHub Actions workflow to deploy MkDocs to GitHub Pages Dec 2, 2025
Copilot AI requested a review from ianlintner December 2, 2025 17:26
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.

Publish mkdocs doc site to gh pages

2 participants