Yoast / Yoast/developer

Update docs: Yoast SEO News sitemap

Open
#257 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
15
Forks
23
PR merge metrics
No merged PRs in 30d

Description

Please give us a description of the issue

The default Yoast SEO News sitemap is at /news-sitemap.xml/. But when there's a CPT with the name News, the default Yoast SEO News sitemap becomes /yoast-news-sitemap.xml/ while the CPT sitemap becomes /news-sitemap.xml/. This should reflect in the documentation at https://developer.yoast.com/features/xml-sitemaps/functional-specification/#news-sitemaps

  • I've read and understood the contribution guidelines.
  • I've searched for any related issues and avoided creating a duplicate issue.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the linked functional specification's News sitemaps section and compare its documented default URL with the behavior described for a News CPT. Update the documentation to show both sitemap URLs and their respective cases, then review the rendered section to confirm the distinction is clear.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.