Skip to content

[Docs site] Add util to generate descriptions and port into mdx files #25715

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 9 commits into from
Closed

[Docs site] Add util to generate descriptions and port into mdx files #25715

wants to merge 9 commits into from

Conversation

@kodster28
Copy link
Collaborator

@kodster28 kodster28 commented Oct 8, 2025 •
edited
Loading

Summary

Add a new script to help us generate descriptions (from rendered HTML) and then add them to the frontmatter of associated mdx files.

npx tsx bin/generate-descriptions.ts --pcx-content-type tutorial

@github-actions github-actions bot added the size/m label Oct 8, 2025
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025 •
edited
Loading

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
* @cloudflare/pcx-technical-writing
/src/content/docs/1.1.1.1/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
/src/content/docs/ai-gateway/ @abhishekkankani, @palashgo, @thebongy, @kathayl, @mchenco, @kodster28, @cloudflare/pcx-technical-writing
/src/content/docs/analytics/ @jimhawkridge, @soheiokamoto, @angelampcosta, @cloudflare/pcx-technical-writing
/src/content/docs/automatic-platform-optimization/ @cloudflare/pcx-technical-writing
/src/content/docs/browser-rendering/ @mchenco, @cloudflare/pcx-technical-writing, @celso, @danielgek, @kathayl, @ToriLindsay
/src/content/docs/byoip/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
/src/content/docs/cloudflare-for-platforms/ @irvinebroque, @dinasaur404, @cloudflare/pcx-technical-writing
/src/content/docs/cloudflare-one/ @ranbel, @cloudflare/pcx-technical-writing
/src/content/docs/d1/ @elithrar, @rozenmd, @vy-ton, @joshthoward, @oxyjun, @harshil1712, @cloudflare/pcx-technical-writing
/src/content/docs/dns/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
/src/content/docs/durable-objects/ @elithrar, @vy-ton, @joshthoward, @oxyjun, @harshil1712, @mikenomitch, @cloudflare/pcx-technical-writing, @cloudflare/workers-runtime-1
/src/content/docs/fundamentals/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/hyperdrive/ @elithrar, @thomasgauvin, @sejoker, @oxyjun, @cloudflare/pcx-technical-writing
/src/content/docs/load-balancing/ @angelampcosta, @cloudflare/pcx-technical-writing
/src/content/docs/magic-firewall/ @Maddy-Cloudflare, @cloudflare/pcx-technical-writing
/src/content/docs/magic-network-monitoring/ @marciocloudflare, @cloudflare/pcx-technical-writing
/src/content/docs/magic-transit/ @marciocloudflare, @cloudflare/pcx-technical-writing
/src/content/docs/magic-wan/ @marciocloudflare, @cloudflare/pcx-technical-writing
/src/content/docs/page-shield/ @pedrosousa, @cloudflare/pcx-technical-writing
/src/content/docs/pages/ @cloudflare/workers-docs, @GregBrimble, @WalshyDev, @aninibread, @irvinebroque, @cloudflare/pcx-technical-writing, @kodster28
/src/content/docs/pub-sub/ @elithrar, @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/pulumi/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/r2/ @oxyjun, @elithrar, @jonesphillip, @aninibread, @harshil1712, @cloudflare/workers-docs, @cloudflare/pcx-technical-writing
/src/content/docs/reference-architecture/ @securitypedant, @haleycode, @cloudflare/pcx-technical-writing
/src/content/docs/registrar/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/rules/ @pedrosousa, @cloudflare/pcx-technical-writing
/src/content/docs/secrets-store/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
/src/content/docs/ssl/ @RebeccaTamachiro, @cloudflare/pcx-technical-writing
/src/content/docs/terraform/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/turnstile/ @migueldemoura, @punkeel, @worenga, @patriciasantaana, @cloudflare/pcx-technical-writing
/src/content/docs/version-management/ @dcpena, @cloudflare/pcx-technical-writing
/src/content/docs/waiting-room/ @angelampcosta, @cloudflare/pcx-technical-writing
/src/content/docs/workers-ai/ @rita3ko, @craigsdennis, @markdembo, @mchenco, @kodster28, @cloudflare/pcx-technical-writing
/src/content/docs/workers/static-assets @irvinebroque, @GregBrimble, @WalshyDev, @kodster28, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing
/src/content/docs/workers/ @cloudflare/workers-docs, @GregBrimble, @irvinebroque, @mikenomitch, @korinne, @WalshyDev, @cloudflare/deploy-config, @cloudflare/pcx-technical-writing, @kodster28, @cloudflare/wrangler, @cloudflare/workers-runtime-1

@kodster28 kodster28 mentioned this pull request Oct 8, 2025
Merged
12 tasks
@github-actions
Copy link
Contributor

github-actions bot commented Oct 8, 2025 •
edited
Loading

Preview URL: https://54e1de88.preview.developers.cloudflare.com
Preview Branch URL: https://generate-description-util.preview.developers.cloudflare.com

@github-actions
Copy link
Contributor

github-actions bot commented Oct 9, 2025

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

Redirects

This PR changes current filenames or deletes current files. Make sure you have redirects set up to cover the following paths:

  • /pages/migrations/migrating-from-netlify/
  • /pages/migrations/migrating-from-vercel/
  • /pages/migrations/migrating-from-workers/

@github-actions
Copy link
Contributor

github-actions bot commented Oct 9, 2025

CI run failed: build logs

@kodster28 kodster28 closed this Oct 9, 2025
@kodster28
Copy link
Collaborator Author

kodster28 commented Oct 9, 2025

Closing.... need to tweak the script to avoid a bunch of manual updates

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

Reviewers

@haleycode haleycode haleycode approved these changes

@kristianfreeman kristianfreeman Awaiting requested review from kristianfreeman

@pedrosousa pedrosousa Awaiting requested review from pedrosousa pedrosousa is a code owner

@GregBrimble GregBrimble Awaiting requested review from GregBrimble GregBrimble is a code owner

@KianNH KianNH Awaiting requested review from KianNH

@WalshyDev WalshyDev Awaiting requested review from WalshyDev WalshyDev is a code owner

@angelampcosta angelampcosta Awaiting requested review from angelampcosta angelampcosta is a code owner

@migueldemoura migueldemoura Awaiting requested review from migueldemoura migueldemoura is a code owner

@punkeel punkeel Awaiting requested review from punkeel punkeel is a code owner

@patriciasantaana patriciasantaana Awaiting requested review from patriciasantaana patriciasantaana is a code owner

@RebeccaTamachiro RebeccaTamachiro Awaiting requested review from RebeccaTamachiro RebeccaTamachiro is a code owner

@marciocloudflare marciocloudflare Awaiting requested review from marciocloudflare marciocloudflare is a code owner

@Maddy-Cloudflare Maddy-Cloudflare Awaiting requested review from Maddy-Cloudflare Maddy-Cloudflare is a code owner

@irvinebroque irvinebroque Awaiting requested review from irvinebroque irvinebroque is a code owner

@dinasaur404 dinasaur404 Awaiting requested review from dinasaur404 dinasaur404 is a code owner

@mikenomitch mikenomitch Awaiting requested review from mikenomitch mikenomitch is a code owner

@korinne korinne Awaiting requested review from korinne korinne is a code owner

@Oxyjun Oxyjun Awaiting requested review from Oxyjun Oxyjun is a code owner

@elithrar elithrar Awaiting requested review from elithrar elithrar is a code owner

@jonesphillip jonesphillip Awaiting requested review from jonesphillip jonesphillip is a code owner

@aninibread aninibread Awaiting requested review from aninibread aninibread is a code owner

@harshil1712 harshil1712 Awaiting requested review from harshil1712 harshil1712 is a code owner

@dcpena dcpena Awaiting requested review from dcpena dcpena is a code owner

@thomasgauvin thomasgauvin Awaiting requested review from thomasgauvin thomasgauvin is a code owner

@sejoker sejoker Awaiting requested review from sejoker sejoker is a code owner

@vy-ton vy-ton Awaiting requested review from vy-ton vy-ton is a code owner

@joshthoward joshthoward Awaiting requested review from joshthoward joshthoward is a code owner

@rozenmd rozenmd Awaiting requested review from rozenmd rozenmd is a code owner

@ranbel ranbel Awaiting requested review from ranbel ranbel is a code owner

@mchenco mchenco Awaiting requested review from mchenco mchenco is a code owner

@celso celso Awaiting requested review from celso celso is a code owner

@kathayl kathayl Awaiting requested review from kathayl kathayl is a code owner

@ToriLindsay ToriLindsay Awaiting requested review from ToriLindsay ToriLindsay is a code owner

@soheiokamoto soheiokamoto Awaiting requested review from soheiokamoto soheiokamoto is a code owner

@rita3ko rita3ko Awaiting requested review from rita3ko rita3ko is a code owner

@craigsdennis craigsdennis Awaiting requested review from craigsdennis craigsdennis is a code owner

@markdembo markdembo Awaiting requested review from markdembo

@abhishekkankani abhishekkankani Awaiting requested review from abhishekkankani abhishekkankani is a code owner

@palashgo palashgo Awaiting requested review from palashgo palashgo is a code owner

@thebongy thebongy Awaiting requested review from thebongy thebongy is a code owner

@securitypedant securitypedant Awaiting requested review from securitypedant securitypedant is a code owner

Assignees

@pedrosousa pedrosousa

@kristianfreeman kristianfreeman

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@haleycode haleycode

@KianNH KianNH

Labels

October 2025 size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@kodster28 @haleycode @pedrosousa @kristianfreeman @GregBrimble @WalshyDev @KianNH