Skip to content

Conversation

@Oxyjun
Copy link
Contributor

@Oxyjun Oxyjun commented Apr 10, 2025

Summary

  1. Adding a new page on WranglerConfig with an example.
  2. Providing more guidance around the repo and file components in the GitHubCode component.

Screenshots (optional)

Documentation checklist

  • The documentation style guide has been adhered to.
  • If a larger change - such as adding a new page- an issue has been opened in relation to any incorrect or out of date information that this PR fixes.
  • Files which have changed name or location have been allocated redirects.

@Oxyjun Oxyjun requested review from a team and dcpena as code owners April 10, 2025 14:27
@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Apr 10, 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

Enhanced documentation for WranglerConfig and GitHubCode components.

  • Added a new page for WranglerConfig with usage examples.
  • Improved guidance on the repo and file components in GitHubCode.

Modified Files

  • src/content/docs/style-guide/components/github-code.mdx

Added Files

  • src/content/docs/style-guide/components/wrangler-config.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.

component: WranglerConfig
---

This component can be used to automatically generate a `jsonc` version of the `toml` for a Cloudflare [Wrangler configuration file](/workers/wrangler/configuration/).
Copy link
Member

Choose a reason for hiding this comment

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

It will actually do the other way too - give TOML, get JSONC & get JSONC, get TOML.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I did NOT realise that, I'll edit.

@Oxyjun Oxyjun enabled auto-merge (squash) April 14, 2025 15:43
@Oxyjun Oxyjun merged commit cfefad2 into production Apr 14, 2025
11 checks passed
@Oxyjun Oxyjun deleted the jun/style-guide/improvements branch April 14, 2025 15:59
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
* Adding WranglerConfig, adding info on GitHubCode.

* Update src/content/docs/style-guide/components/wrangler-config.mdx
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.

3 participants