Skip to content

docs: document inline comments in _redirects files#28521

Draft
petebacondarwin wants to merge 1 commit intoproductionfrom
devin/1770477989-inline-comments-redirects
Draft

docs: document inline comments in _redirects files#28521
petebacondarwin wants to merge 1 commit intoproductionfrom
devin/1770477989-inline-comments-redirects

Conversation

@petebacondarwin
Copy link
Copy Markdown
Contributor

Summary

Documents the new inline comment support for _redirects files, added in cloudflare/workers-sdk#12467.

Changes to src/content/partials/workers/redirects.mdx:

  • Adds a new ### Comments subsection documenting both full-line and inline comment syntax
  • Explains how inline comments interact with URL fragments (space-delimited # starts a comment; # within a URL like /page#section is preserved)
  • Adds a code example demonstrating full-line comments, inline comments, and fragment preservation
  • Adds an inline comment to the existing "complete example" block for consistency

Important

Do not merge until the backend is running the new version of workers-shared that includes inline comment support. The feature is implemented in workers-shared (PR) and won't be live until the backend picks up the new package version.

Documentation checklist

Co-Authored-By: pbacondarwin@cloudflare.com <pete@bacondarwin.com>
@github-actions
Copy link
Copy Markdown
Contributor

This PR requires additional review attention because it affects the following areas:

Partials

This PR updates partial files, which are pieces of content used across multiple files in our Render component.

@petebacondarwin
Copy link
Copy Markdown
Contributor Author

This is reapplying #28171 after it got merged too soon.

cc @MattieTK and @vicb

@github-actions
Copy link
Copy Markdown
Contributor

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

Pattern Owners
/src/content/partials/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @cloudflare/wrangler, @mattietk

@github-actions
Copy link
Copy Markdown
Contributor

@github-actions
Copy link
Copy Markdown
Contributor

Hey there, we've marked this pull request as stale because there's no recent activity on it. This label is helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant).

@github-actions
Copy link
Copy Markdown
Contributor

Hey there, we've marked this pull request as stale because there's no recent activity on it. This label helps us identify PRs that might need updates (or to be closed out by our team if no longer relevant).

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.

6 participants