Skip to content

Conversation

Copy link
Contributor

Copilot AI commented Oct 17, 2025

Problem

The documentation site was being published at https://funz.github.io/fz.github.io (using the repository name as the path), but we want it to be published at the cleaner URL https://funz.github.io/fz.

Solution

Updated the MkDocs configuration to use /fz as the base path for the GitHub Pages deployment.

Changes Made

  1. mkdocs.yml - Updated site_url from https://funz.github.io to https://funz.github.io/fz
  2. README.md - Updated all documentation links to include the /fz base path

Impact

  • All canonical URLs in the generated site now use the /fz base path
  • Sitemap and SEO metadata correctly reflect the new URL structure
  • All internal navigation links continue to work correctly (they use relative paths)
  • No changes required to the GitHub Actions deployment workflow

Verification

  • ✅ Built site successfully with mkdocs build
  • ✅ Verified canonical URLs in generated HTML pages point to https://funz.github.io/fz/...
  • ✅ Confirmed sitemap.xml contains correct URLs with /fz base path
  • ✅ All 35 HTML pages generated successfully
  • ✅ Code review passed with no issues

Once merged, the documentation will be accessible at the new URL: https://funz.github.io/fz

Original prompt

can you change setup of this project so it is published at https://funz.github.io/fz, intead of https://funz.github.io/fz.github.io


✨ 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: yannrichet-asnr <148193180+yannrichet-asnr@users.noreply.github.com>
Copilot AI changed the title [WIP] Change project setup to publish at https://funz.github.io/fz Update GitHub Pages deployment URL from /fz.github.io to /fz Oct 17, 2025
Copilot AI requested a review from yannrichet-asnr October 17, 2025 15:46
@yannrichet-asnr yannrichet-asnr marked this pull request as ready for review October 17, 2025 15:47
@yannrichet-asnr yannrichet-asnr merged commit 0b47312 into main Oct 17, 2025
2 checks passed
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