Skip to content

Conversation

@kodster28
Copy link
Collaborator

@kodster28 kodster28 commented Jun 24, 2025

Summary

  • Removes the noindex blanket statement for /style-guide/ (though adds the chatbot_deprioritize across since not relevant for chat).
  • Updates the Content strategy > Content types titles to be less SEO capturing
  • Adds disambiguation links where possible
  • Fixes the guidelines for the Cloudflare Changelog to be more reflective of best practices today
  • Adds DirectoryListing to the top-level style-guide landing page to experiment with that as a navigation pattern

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Jun 24, 2025

Howdy and thanks for contributing to our repo. The Cloudflare team reviews new, external PRs within two (2) weeks. If it's been two weeks or longer without any movement, please tag the PR Assignees in a comment.

We review internal PRs within 1 week. If it's something urgent or has been sitting without a comment, start a thread in the Developer Docs space internally.


PR Change Summary

Updated the style guide to improve SEO and content clarity.

  • Removed the noindex directive for the style guide while adding chatbot_deprioritize for chat relevance.
  • Revised content type titles for better SEO alignment.
  • Added disambiguation links to enhance user navigation.
  • Updated guidelines for the Cloudflare Changelog to reflect current best practices.

Modified Files

  • src/content/docs/style-guide/documentation-content-strategy/content-types/3rd-party-integration-guide.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/changelog.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/concept.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/configuration.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/design-guide.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/faq.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/get-started.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/how-to.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/implementation-guide.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/reference-architecture.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/reference.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/troubleshooting.mdx
  • src/content/docs/style-guide/documentation-content-strategy/content-types/tutorial.mdx

How can I customize these reviews?

Check out the Hyperlint AI Reviewer docs for more information on how to customize the review.

If you just want to ignore it on this PR, you can add the hyperlint-ignore label to the PR. Future changes won't trigger a Hyperlint review.

Note specifically for link checks, we only check the first 30 links in a file and we cache the results for several hours (for instance, if you just added a page, you might experience this). Our recommendation is to add hyperlint-ignore to the PR to ignore the link check for this PR.

@github-actions
Copy link
Contributor

This pull request requires reviews from CODEOWNERS as it changes files that match the following patterns:

Pattern Owners
*.astro @cloudflare/developer-advocacy, @kristianfreeman, @kodster28, @pedrosousa, @haleycode, @GregBrimble, @KianNH, @WalshyDev
/src/content/docs/style-guide/ @dcpena, @cloudflare/pcx-technical-writing

@github-actions
Copy link
Contributor

github-actions bot commented Jun 24, 2025

Preview URL: https://bf7e7500.preview.developers.cloudflare.com
Preview Branch URL: https://style-guide-reindex.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/changelog/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/changelog/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/get-started/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/get-started/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/implementation-guide/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/implementation-guide/
https://developers.cloudflare.com/style-guide/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/design-guide/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/design-guide/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference-architecture-diagram/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference-architecture/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference-architecture/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/how-to/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/how-to/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/configuration/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/configuration/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/troubleshooting/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/troubleshooting/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/reference/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/3rd-party-integration-guide/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/3rd-party-integration-guide/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/concept/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/concept/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/faq/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/faq/
https://developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/tutorial/ https://style-guide-reindex.preview.developers.cloudflare.com/style-guide/documentation-content-strategy/content-types/tutorial/

kodster28 and others added 2 commits June 24, 2025 15:35
@kodster28 kodster28 merged commit 878621b into production Jun 24, 2025
11 checks passed
@kodster28 kodster28 deleted the style-guide-reindex branch June 24, 2025 21:05
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* [Style guide] Remove noindex + content type updates

* Add disambiguation sections

* disambig for changelog

* Add IA tree to /style-guide/

* Update src/content/docs/style-guide/documentation-content-strategy/content-types/changelog.mdx

Co-authored-by: Denise Peña <[email protected]>

* tweaks

---------

Co-authored-by: Denise Peña <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

8 participants