docs: add custom domain and sitemap for GitHub Pages#16
Merged
Conversation
Configure open-bedrock-server.teabranch.dev as custom domain, add jekyll-sitemap plugin for sitemap.xml generation, and add footer_content to align with open-responses-server docs site. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Review Summary by QodoConfigure custom domain and sitemap for GitHub Pages
WalkthroughsDescription• Configure custom domain open-bedrock-server.teabranch.dev via CNAME file • Add jekyll-sitemap plugin for automatic sitemap generation • Update site URL and baseurl for custom domain routing • Add footer content to align with documentation standards Diagramflowchart LR
A["docs/_config.yml"] -->|update URL config| B["Custom domain setup"]
C["docs/CNAME"] -->|define domain| B
D["docs/Gemfile"] -->|add jekyll-sitemap| E["Sitemap generation"]
B -->|enable| F["open-bedrock-server.teabranch.dev"]
E -->|generate| G["sitemap.xml"]
File Changes1. docs/CNAME
|
Code Review by Qodo
|
There was a problem hiding this comment.
Pull request overview
This PR updates the Jekyll docs site configuration to support serving the documentation from a custom domain and to automatically generate a sitemap.xml for search engines.
Changes:
- Add
jekyll-sitemap(Gem +_config.ymlplugin) to generatesitemap.xml. - Configure GitHub Pages custom domain via
docs/CNAMEand update Jekyllurl/baseurl. - Add
footer_contentin_config.ymlfor consistent site footer branding.
Reviewed changes
Copilot reviewed 3 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/Gemfile | Adds jekyll-sitemap dependency |
| docs/Gemfile.lock | Locks jekyll-sitemap and its resolved dependency set |
| docs/CNAME | Declares the GitHub Pages custom domain |
| docs/_config.yml | Sets url/baseurl, adds footer_content, enables jekyll-sitemap plugin |
Comments suppressed due to low confidence (1)
docs/CNAME:2
- The
CNAMEfile currently has an extra blank line after the domain. GitHub Pages expects the file to contain just the custom domain value; please remove the trailing empty line/whitespace to avoid any parsing issues.
open-bedrock-server.teabranch.dev
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| baseurl: "/open-bedrock-server" | ||
| url: "https://teabranch.github.io" | ||
| baseurl: "" | ||
| url: "https://open-bedrock-server.teabranch.dev" |
There was a problem hiding this comment.
site.url is now hardcoded to the custom domain. Until the GitHub Pages custom domain is actually enabled (and actions/configure-pages updates its outputs), the deployed site URL may still be the teabranch.github.io/open-bedrock-server project page, but SEO tags and jekyll-sitemap will emit canonical/sitemap URLs for open-bedrock-server.teabranch.dev. Consider setting url at build time from actions/configure-pages outputs (or delaying this change until the domain is enabled) to avoid publishing incorrect canonical URLs during the transition. Also update docs/README.md’s “Live Site” link so it matches the new domain.
Suggested change
| url: "https://open-bedrock-server.teabranch.dev" | |
| url: "" |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
open-bedrock-server.teabranch.devas custom domain (CNAME)jekyll-sitemapplugin for automaticsitemap.xmlgenerationfooter_contentto_config.ymlto align with open-responses-server docs siteurlandbaseurlfor custom domain routingManual steps after merge
open-bedrock-server.teabranch.dev→teabranch.github.ioTest plan
bundle installresolves jekyll-sitemapbundle exec jekyll buildsucceeds_site/sitemap.xmlgenerated with correct domain URLs_site/CNAMEpresent in build output🤖 Generated with Claude Code