Skip to content

[Doc] Add CNAME file to preserve custom domain across deployments#278

Merged
koic merged 1 commit intomodelcontextprotocol:mainfrom
koic:cname_ruby_sdk_modelcontextprotocol_io
Mar 30, 2026
Merged

[Doc] Add CNAME file to preserve custom domain across deployments#278
koic merged 1 commit intomodelcontextprotocol:mainfrom
koic:cname_ruby_sdk_modelcontextprotocol_io

Conversation

@koic
Copy link
Copy Markdown
Member

@koic koic commented Mar 30, 2026

Motivation and Context

Accessing https://ruby.sdk.modelcontextprotocol.io/ is expected to show the content of https://modelcontextprotocol.github.io/ruby-sdk/, but it currently does not. This change fixes that issue.

The generate-gh-pages.sh script cleans all files from the gh-pages branch root before copying from docs/. This removes the CNAME file that GitHub Pages uses for the custom domain, causing ruby.sdk.modelcontextprotocol.io to break on every release.
https://github.com/modelcontextprotocol/ruby-sdk/blob/v0.10.0/bin/generate-gh-pages.sh#L91-L93

By placing the CNAME file in docs/, it will be automatically copied to gh-pages during each deployment. https://github.com/modelcontextprotocol/ruby-sdk/blob/v0.10.0/bin/generate-gh-pages.sh#L95-L97

The following is a PR related to the configuration of ruby.sdk.modelcontextprotocol.io.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)
  • Documentation update

Checklist

  • I have read the MCP Documentation
  • My code follows the repository's style guidelines
  • New and existing tests pass locally
  • I have added appropriate error handling
  • I have added or updated documentation as needed

Accessing https://ruby.sdk.modelcontextprotocol.io/ is expected to show
the content of https://modelcontextprotocol.github.io/ruby-sdk/,
but it currently does not. This change fixes that issue.

The `generate-gh-pages.sh` script cleans all files from the gh-pages branch root
before copying from `docs/`. This removes the CNAME file that GitHub Pages uses for
the custom domain, causing `ruby.sdk.modelcontextprotocol.io` to break on every release.
https://github.com/modelcontextprotocol/ruby-sdk/blob/v0.10.0/bin/generate-gh-pages.sh#L91-L93

By placing the CNAME file in `docs/`, it will be automatically copied to `gh-pages` during each deployment.
https://github.com/modelcontextprotocol/ruby-sdk/blob/v0.10.0/bin/generate-gh-pages.sh#L95-L97

The following is a PR related to the configuration of ruby.sdk.modelcontextprotocol.io.

- modelcontextprotocol#181
- modelcontextprotocol/dns#14
- modelcontextprotocol/modelcontextprotocol#2486
@koic koic merged commit 6b415e2 into modelcontextprotocol:main Mar 30, 2026
11 checks passed
@koic koic deleted the cname_ruby_sdk_modelcontextprotocol_io branch March 30, 2026 15:16
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