Skip to content

[Docs Site] Enforce and transform frontmatter tags #22836

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 5 commits into from
Jun 3, 2025

Conversation

KianNH
Copy link
Member

@KianNH KianNH commented Jun 2, 2025

Summary

Enforce and transform frontmatter tags

const { entry } = locals.starlightRoute;
const { tags } = entry.data;

if (tags) {
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider adding an additional check for empty tag arrays to avoid unnecessary processing:

Suggested change
if (tags) {
if (tags && tags.length > 0) {

Copy link
Contributor

github-actions bot commented Jun 2, 2025

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

Pattern Owners
*.ts @cloudflare/developer-advocacy, @kristianfreeman, @kodster28, @pedrosousa, @haleycode, @GregBrimble, @KianNH, @WalshyDev
*.astro @cloudflare/developer-advocacy, @kristianfreeman, @kodster28, @pedrosousa, @haleycode, @GregBrimble, @KianNH, @WalshyDev
/src/content/docs/kv/ @elithrar, @thomasgauvin, @rts-rob, @oxyjun, @cloudflare/pcx-technical-writing
/src/content/docs/style-guide/ @dcpena, @cloudflare/pcx-technical-writing
/src/schemas/tags.ts @kodster28, @KianNH, @joslyn-cf

@kodster28 kodster28 mentioned this pull request Jun 2, 2025
Copy link
Contributor

hyperlint-ai bot commented Jun 2, 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

Enforced and transformed frontmatter tags across multiple documentation examples.

  • Removed 'tags' from frontmatter in several example files
  • Updated formatting for consistency in code examples
  • Improved clarity in documentation regarding configuration and performance optimization

Modified Files

  • src/content/docs/kv/examples/cache-data-with-workers-kv.mdx
  • src/content/docs/kv/examples/distributed-configuration-with-workers-kv.mdx
  • src/content/docs/kv/examples/implement-ab-testing-with-workers-kv.mdx
  • src/content/docs/kv/examples/routing-with-workers-kv.mdx
  • src/content/docs/kv/examples/workers-kv-to-serve-assets.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

github-actions bot commented Jun 2, 2025

@KianNH KianNH requested a review from dcpena as a code owner June 3, 2025 16:27
@kodster28 kodster28 merged commit aaacc3c into production Jun 3, 2025
11 checks passed
@kodster28 kodster28 deleted the kian/PCX-16226 branch June 3, 2025 17:27
sdnts pushed a commit to sdnts/cloudflare-docs that referenced this pull request Jul 24, 2025
* [Docs Site] Enforce and transform frontmatter tags

* remove KV tags

* other content updates

* update tags docs and error

---------

Co-authored-by: kodster28 <kody@cloudflare.com>
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