canonical / canonical/sphinx-stack-docs

docs: "Set up Sphinx sitemaps" gives too many choices ;)

Open
#3 1 comment 0 reactions 0 assignees View on GitHub
documentation
Dominant language
No language data
Stars
4
Forks
11
Avg merge
13d 16h
Merged PRs (30d)
2

Description

I'm working to validate the sitemaps generated in our pages, but am presented with too many choices in the starter pack :)

> It is recommended to generate a sitemap for your documentation using the [sphinx-sitemap](https://sphinx-sitemap.readthedocs.io/en/latest/index.html) extension.

But then, RTD sitemaps are referred to across the doc…

---

> Configuring your versioned documentation to use an appropriate version may be sufficient

> if you want comprehensive sitemaps for your documentation and all its versions

Do I want them…?

---

I would like to know what's the best practice that I should follow…

---
*Reported from: https://canonical-starter-pack.readthedocs-hosted.com/stable/how-to/set-up-sitemaps/*

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.