Skip to content

The site is served at doc.beffroi.tech - #9

Merged
Spomky merged 1 commit into
0.1from
docs/the-site-is-served-at-doc-beffroi-tech
Oct 26, 2026
Merged

Spomky merged 1 commit into
0.1from
docs/the-site-is-served-at-doc-beffroi-tech

Conversation

@Spomky

@Spomky Spomky commented Oct 26, 2026

Copy link
Copy Markdown
Contributor

Pages already serves the site at https://doc.beffroi.tech/: the CNAME file at the root of gh-pages names the domain, the certificate is approved and HTTPS is enforced. This brings the site's own configuration in line with it.

  • mkdocs.yml: site_url is https://doc.beffroi.tech/, so the canonical address, the sitemap and the share image of every page are under https://doc.beffroi.tech/<version>/ instead of https://beffroi-auth.github.io/docs/<version>/.
  • docs/overrides/main.html: the share image was {{ config.site_url }}latest/.... mike sets site_url to the address of the version without a trailing slash, so the published pages carried https://beffroi-auth.github.io/docs/0.1latest/assets/images/beffroi-og-image-1200x630.png, an address that does not exist. The image is now read from the version the page belongs to, which carries the same file.
  • README.md names the new address, and .github/workflows/pages.yml says where the domain is set and why mike never touches that file (it writes only the directories of a version and its aliases, the root redirect and versions.json).

Checked with make check, and with a mike deploy of 0.1 into a local throwaway branch: canonical https://doc.beffroi.tech/0.1/ and https://doc.beffroi.tech/0.1/oidc/, sitemap https://doc.beffroi.tech/0.1/, share image https://doc.beffroi.tech/0.1/assets/images/beffroi-og-image-1200x630.png, which answers 200 today.

… read from the version of the page

site_url names the domain the CNAME file at the root of gh-pages gives Pages, so the canonical address, the
sitemap and the share image of every page are under https://doc.beffroi.tech/<version>/. The share image was
read from site_url followed by "latest/", but mike sets site_url to the address of the version without a
trailing slash, which gave .../0.1latest/assets/...; it is now read from the version the page belongs to,
which carries the same file. The README names the address, and the publication workflow says where the
domain is set and why mike leaves it alone.
@Spomky
Spomky merged commit a875452 into 0.1 Oct 26, 2026
2 checks passed
@Spomky
Spomky deleted the docs/the-site-is-served-at-doc-beffroi-tech branch October 26, 2026 14:45
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.

1 participant