Skip to content

fix: add CNAME to deploy script and site_url for docs.codecarbon.io#1086

Merged
SaboniAmine merged 1 commit intomasterfrom
fix/docs-deploy-cname-master
Feb 27, 2026
Merged

fix: add CNAME to deploy script and site_url for docs.codecarbon.io#1086
SaboniAmine merged 1 commit intomasterfrom
fix/docs-deploy-cname-master

Conversation

@davidberenstein1957
Copy link
Collaborator

Will this trigger the workflow? Yes. The deploy-docs workflow runs on push to master when scripts/deploy-docs.sh or mkdocs.yml changes. Merging this PR will trigger a deploy that pushes to gh-pages with the CNAME file included.

Changes:

  • scripts/deploy-docs.sh: Write CNAME file (docs.codecarbon.io) on every deploy so future deploys always include the custom domain
  • mkdocs.yml: Set site_url to https://docs.codecarbon.io/ for correct asset paths when served from the custom domain

Related: PR #1085 adds CNAME directly to gh-pages for immediate fix. This PR ensures master has the fix so the deploy workflow keeps CNAME on every future deploy.

Made with Cursor

- deploy-docs.sh: write CNAME file so every deploy includes custom domain
- mkdocs.yml: set site_url to docs.codecarbon.io for correct asset paths

Merging to master will trigger the deploy-docs workflow, which will push
to gh-pages with CNAME included.

Made-with: Cursor
@davidberenstein1957 davidberenstein1957 requested a review from a team as a code owner February 27, 2026 10:04
Copy link
Member

@SaboniAmine SaboniAmine left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@SaboniAmine SaboniAmine merged commit e0d6ebe into master Feb 27, 2026
6 checks passed
@SaboniAmine SaboniAmine deleted the fix/docs-deploy-cname-master branch February 27, 2026 10:06
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