Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs: improve sitemap and custom sitemap docs #10816

Closed
agjohnson opened this issue Oct 12, 2023 · 2 comments · Fixed by #11585
Closed

Docs: improve sitemap and custom sitemap docs #10816

agjohnson opened this issue Oct 12, 2023 · 2 comments · Fixed by #11585
Labels
Needed: documentation Documentation is required

Comments

@agjohnson
Copy link
Contributor

A few notes for our sitemap docs:

  • The note on using a custom sitemap just says "contact support". Instead, we should describe how to use a custom sitemap through a custom "robots.txt". That is, in a custom robots.txt on the default version, add the Sitemap: https://slug.readthedocs.io/en/latest/sitemap.xml directive.
  • The sitemap feature page spends a lot of time describing what a sitemap is, where we should probably make the focus of this page on our own support of sitemaps.
  • We refer to sitemaps in multiple places as sitemap.xml. https://sitemaps.org uses "Sitemaps", though I think a lowercase "sitemaps" is okay too.

And because it's currently coming up for me as the first search hit in our docs for "sitemap", it's probably worth noting that the SEO guide feels slightly out of place on our own docs. It's good content though, so I'm not quite sure what to do with it. Is this maybe better website content? This can be a separate conversation, especially if changing the page title of the sitemap feature page bumps it up in the results.

@humitos humitos added the Needed: documentation Documentation is required label Oct 16, 2023
@astrojuanlu
Copy link
Contributor

Was this fixed in #10899 ?

@humitos
Copy link
Member

humitos commented Sep 5, 2024

I opened #11585 with the missing small changes requested in this issue 👍🏼 . Thanks for the pointer.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Needed: documentation Documentation is required
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants