Skip to content

docs: document inline comments in _redirects files#28171

Merged
MattieTK merged 1 commit intoproductionfrom
devin/1770477989-inline-comments-redirects
Feb 21, 2026
Merged

docs: document inline comments in _redirects files#28171
MattieTK merged 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


Link to Devin run: https://app.devin.ai/sessions/b6cb3af4527945cfadfb345c2921fe86
Requested by: @petebacondarwin

Co-Authored-By: pbacondarwin@cloudflare.com <pete@bacondarwin.com>
@devin-ai-integration
Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 7, 2026

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.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Feb 7, 2026

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 Bot commented Feb 7, 2026

@MattieTK
Copy link
Copy Markdown
Member

While testing this OpenCode found this bug which I've raised a PR for cloudflare/workers-sdk#12627

@MattieTK MattieTK merged commit 7d32ed3 into production Feb 21, 2026
12 checks passed
@MattieTK MattieTK deleted the devin/1770477989-inline-comments-redirects branch February 21, 2026 16:07
@petebacondarwin
Copy link
Copy Markdown
Contributor Author

@MattieTK - did you confirm that the inline comment support is live in production?
I think @vicb was working on rolling it out and it wasn't entirely trivial.

@MattieTK MattieTK restored the devin/1770477989-inline-comments-redirects branch February 22, 2026 01:44
MattieTK added a commit that referenced this pull request Feb 22, 2026
@MattieTK
Copy link
Copy Markdown
Member

@MattieTK - did you confirm that the inline comment support is live in production? I think @vicb was working on rolling it out and it wasn't entirely trivial.

agh, I tested this locally and assumed wrongly given that it worked locally that it would be the same in prod, but deploying the worker does throw errors in the deployment linter.

Sorry! I've thrown up a revert.

@vicb
Copy link
Copy Markdown
Contributor

vicb commented Feb 22, 2026

@MattieTK - did you confirm that the inline comment support is live in production? I think @vicb was working on rolling it out and it wasn't entirely trivial.

It's not live.
I have 2 PRs waiting for review from Greg. I'll work on getting them approved this coming week. Then this should be rolled out. I guess the whole process will take at least a week.

@MattieTK
Copy link
Copy Markdown
Member

@vicb no worries, I've since got this change reverted so once you're ready then we can revert that revert.

My bad for assuming that what worked locally was enabled remotely.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

7 participants