Skip to content

docs: point site_url at the docs.cososo.co.uk custom domain#616

Merged
DavidCozens merged 1 commit into
mainfrom
docs/site-url-custom-domain
Jul 13, 2026
Merged

docs: point site_url at the docs.cososo.co.uk custom domain#616
DavidCozens merged 1 commit into
mainfrom
docs/site-url-custom-domain

Conversation

@DavidCozens

@DavidCozens DavidCozens commented Jul 13, 2026

Copy link
Copy Markdown
Collaborator

The docs are going live behind docs.cososo.co.uk/solid-syslog/ (path-preserving redirect to the GitHub Pages URL). Point site_url at the public custom domain so canonical links, og:url, and the generated sitemap reference it rather than the cososo-ltd.github.io origin.

One line in mkdocs.yml. Internal navigation uses relative URLs, so nav is unaffected; site_url drives the canonical/sitemap/social metadata only. The /solid-syslog/ subpath is retained deliberately (leaves room for a docs.cososo.co.uk/<product>/ family).

Follow-up to the S23.04 go-live (#250). No Closes — that story is already merged.

Summary by CodeRabbit

  • Documentation
    • Updated the documentation site address to the new official domain.
    • Existing documentation content and configuration remain unchanged.

The docs now serve behind the docs.cososo.co.uk/solid-syslog/ custom domain
(path-preserving redirect to the GitHub Pages URL). Point site_url at the
public domain so canonical links, og:url, and the sitemap reference it.
Follow-up to the S23.04 go-live (#250).

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Jul 13, 2026

Copy link
Copy Markdown
Contributor

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: ASSERTIVE

Plan: Pro Plus

Run ID: c2e300d4-6e45-470e-a8cb-95c1a02483cc

📥 Commits

Reviewing files that changed from the base of the PR and between 6120054 and 551ea04.

📒 Files selected for processing (1)
  • mkdocs.yml

Walkthrough

MkDocs site_url now points to https://docs.cososo.co.uk/solid-syslog/ instead of the previous GitHub Pages URL.

Changes

Documentation site configuration

Layer / File(s) Summary
Update MkDocs site URL
mkdocs.yml
Changes site_url to the new documentation domain without altering other MkDocs settings.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Possibly related PRs

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description explains the change, but it does not follow the required template sections for Purpose, Change Description, Test Evidence, and Areas Affected. Rewrite it to use the repository template, adding the four section headings with concise content under each.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title is concise, conventional-commit style, and accurately summarises the site_url domain change.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/site-url-custom-domain

Comment @coderabbitai help to get the list of available commands.

@github-actions

Copy link
Copy Markdown
Contributor

☀️   Quality Summary

   🚦   build-linux-gcc: 100% successful (✔️ 1522 passed)
   🚦   build-freertos-host-tdd-plustcp: 100% successful (✔️ 1873 passed)
   🚦   build-linux-clang: 100% successful (✔️ 1453 passed)
   🚦   sanitize-linux-gcc: 100% successful (✔️ 1453 passed)
   🚦   integration-linux-openssl: 100% successful (✔️ 16 passed)
   🚦   integration-linux-mbedtls: 100% successful (✔️ 14 passed)
   🚦   integration-windows-openssl: 100% successful (✔️ 16 passed)
   🚦   bdd-linux-syslog-ng: 94% successful (✔️ 49 passed, 🙈 3 skipped)
   🚦   bdd-windows-otel: 88% successful (✔️ 46 passed, 🙈 6 skipped)
   🚦   bdd-freertos-qemu-plustcp: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   bdd-freertos-qemu-lwip: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   build-windows-msvc: 100% successful (✔️ 1298 passed)
   🚦   build-linux-tunable-override: 100% successful (✔️ 1453 passed)
   ⚠️   Clang-Tidy: No warnings
   ⚠️   CPPCheck: No warnings


Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result.

@github-actions

Copy link
Copy Markdown
Contributor

☀️   Quality Summary

   🚦   build-linux-gcc: 100% successful (✔️ 1522 passed)
   🚦   build-freertos-host-tdd-plustcp: 100% successful (✔️ 1873 passed)
   🚦   build-linux-clang: 100% successful (✔️ 1453 passed)
   🚦   sanitize-linux-gcc: 100% successful (✔️ 1453 passed)
   🚦   integration-linux-openssl: 100% successful (✔️ 16 passed)
   🚦   integration-linux-mbedtls: 100% successful (✔️ 14 passed)
   🚦   integration-windows-openssl: 100% successful (✔️ 16 passed)
   🚦   bdd-linux-syslog-ng: 94% successful (✔️ 49 passed, 🙈 3 skipped)
   🚦   bdd-windows-otel: 88% successful (✔️ 46 passed, 🙈 6 skipped)
   🚦   bdd-freertos-qemu-plustcp: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   bdd-freertos-qemu-lwip: 87% successful (✔️ 45 passed, 🙈 7 skipped)
   🚦   build-windows-msvc: 100% successful (✔️ 1298 passed)
   🚦   build-linux-tunable-override: 100% successful (✔️ 1453 passed)
   ⚠️   Clang-Tidy: No warnings
   ⚠️   CPPCheck: No warnings


Created by Quality Monitor v1.14.0 (#f3859fd). More details are shown in the GitHub Checks Result.

@DavidCozens DavidCozens merged commit 58cc498 into main Jul 13, 2026
58 of 59 checks passed
@DavidCozens DavidCozens deleted the docs/site-url-custom-domain branch July 13, 2026 20:36
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