Skip to content

chore(docs): Update sitemap and intersphinx - #1206

Merged
erinecon merged 3 commits into
track/1from
chore/update-sitemap
Jul 20, 2026
Merged

chore(docs): Update sitemap and intersphinx#1206
erinecon merged 3 commits into
track/1from
chore/update-sitemap

Conversation

@erinecon

@erinecon erinecon commented Jul 20, 2026

Copy link
Copy Markdown
Contributor

What this PR does

Updates the sitemap configuration.
Updates outdated or removed intersphinx entries.

Why we need it

The RTD project began failing due to the broken intersphinx entries, e.g., https://app.readthedocs.com/projects/canonical-synapse-juju-charm/builds/4225293/

Note that, since the broken intersphinx entries are in track/1, it is expected that the "check URLs" workflow will fail until we merge the fix.

Update the sitemap configuration to be consistent with our other public documentation sets, and to avoid issues when we introduce versioning. Validate with https://canonical-synapse-juju-charm--1206.com.readthedocs.build/1206/doc-sitemap.xml

Checklist

  • I followed the contributing guide
  • I added or updated the documentation (if applicable)
  • [N/A] I updated docs/changelog.md with user-relevant changes
  • I added a change artifact for user-relevant changes in docs/release-notes/artifacts. If no change artifact is necessary, I tagged the PR with the label no-release-note.
  • [N/A] I added or updated tests as needed (unit and integration)
  • [N/A] If integration test modules are used: I updated the workflow configuration
    (e.g., in .github/workflows/integration_tests.yaml, ensure the modules list is correct)
  • [N/A] If this is a Grafana dashboard: I added a screenshot of the dashboard
  • [N/A] If this is Terraform: terraform fmt passes and tflint reports no errors
  • [N/A] If this is Rockcraft: I updated the version

@erinecon erinecon added bug Something isn't working documentation Improvements or additions to documentation trivial labels Jul 20, 2026
@erinecon erinecon added the no-release-note This PR does not require a change artifact label Jul 20, 2026
@erinecon
erinecon marked this pull request as ready for review July 20, 2026 19:07
@erinecon
erinecon merged commit 654198c into track/1 Jul 20, 2026
26 of 27 checks passed
@erinecon
erinecon deleted the chore/update-sitemap branch July 20, 2026 19:41
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working documentation Improvements or additions to documentation Libraries: Out of sync no-release-note This PR does not require a change artifact trivial

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants