Skip to content

[Rules] Update page headings #21707

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

Merged
merged 1 commit into from
Apr 15, 2025

Conversation

pedrosousa
Copy link
Contributor

Summary

Updates page headings in Rules to improve internal results.

External search engines seem to correctly use page titles (in meta tags), but internal results have a few results all named "Create a rule in the dashboard".

@pedrosousa pedrosousa requested a review from a team as a code owner April 15, 2025 14:07
@github-actions github-actions bot added product:rules Related to rules size/s labels Apr 15, 2025
Copy link
Contributor

hyperlint-ai bot commented Apr 15, 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 page headings in the Rules documentation to enhance clarity and improve internal search results.

  • Modified titles to specify the type of rule (compression, configuration, origin) in the API and dashboard sections.
  • Adjusted sidebar order for better navigation.
  • Ensured consistency in heading labels across different rule types.

Modified Files

  • src/content/docs/rules/compression-rules/create-api.mdx
  • src/content/docs/rules/compression-rules/create-dashboard.mdx
  • src/content/docs/rules/configuration-rules/create-api.mdx
  • src/content/docs/rules/configuration-rules/create-dashboard.mdx
  • src/content/docs/rules/origin-rules/create-api.mdx
  • src/content/docs/rules/origin-rules/create-dashboard.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.

Copy link
Contributor

@pedrosousa pedrosousa merged commit c91e114 into production Apr 15, 2025
12 checks passed
@pedrosousa pedrosousa deleted the pedro/2025-04-15-rules-update-page-headings branch April 15, 2025 14:19
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
product:rules Related to rules size/s
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants