Skip to content

[Docs Site] Generate index.md for all index.html files #20988

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
Merged
merged 3 commits into from
Mar 31, 2025
Merged

[Docs Site] Generate index.md for all index.html files #20988

merged 3 commits into from
Mar 31, 2025

Conversation

@KianNH
Copy link
Member

@KianNH KianNH commented Mar 20, 2025

Summary

WIP

@hyperlint-ai
Copy link
Contributor

hyperlint-ai bot commented Mar 20, 2025 •
edited
Loading

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

Updated the documentation site to generate index.md files for all index.html files, enhancing organization and accessibility.

  • Modified the sidebar structure to include a new group label and badge for beta features.
  • Improved the overview section for better clarity and navigation.

Modified Files

  • src/content/docs/workers/index.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.

@github-actions
Copy link
Contributor

github-actions bot commented Mar 20, 2025 •
edited
Loading

Preview URL: https://48e4adee.preview.developers.cloudflare.com
Preview Branch URL: https://kian-pcx-16495.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/style-guide/fixtures/markdown/ https://kian-pcx-16495.preview.developers.cloudflare.com/style-guide/fixtures/markdown/
https://developers.cloudflare.com/style-guide/fixtures/ https://kian-pcx-16495.preview.developers.cloudflare.com/style-guide/fixtures/

@github-actions github-actions bot added product:workers Related to Workers product size/m product:style-guide and removed product:workers Related to Workers product labels Mar 20, 2025
@KianNH KianNH marked this pull request as ready for review March 24, 2025 16:02
@kodster28
Copy link
Collaborator

kodster28 commented Mar 27, 2025

Tested the basic implementation of this, meaning:

  • Active pages render correctly (and without our fancy astro components)
  • Nonexistent pages still 404

@KianNH KianNH merged commit 936de7e into production Mar 31, 2025
11 checks passed
@KianNH KianNH deleted the kian/PCX-16495 branch March 31, 2025 14:01
RebeccaTamachiro pushed a commit that referenced this pull request Apr 21, 2025
@KianNH @RebeccaTamachiro
[Docs Site] Generate index.md for all index.html files (#20988)
792b475 
* [Docs Site] Generate index.md for all index.html files

* remove redundant head config

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

Reviewers

@kodster28 kodster28 kodster28 approved these changes

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

@GregBrimble GregBrimble Awaiting requested review from GregBrimble

@pedrosousa pedrosousa Awaiting requested review from pedrosousa

@WalshyDev WalshyDev Awaiting requested review from WalshyDev

@kristianfreeman kristianfreeman Awaiting requested review from kristianfreeman

@haleycode haleycode Awaiting requested review from haleycode

Assignees

@pedrosousa pedrosousa

@kristianfreeman kristianfreeman

@irvinebroque irvinebroque

@mikenomitch mikenomitch

@maxvp maxvp

@GregBrimble GregBrimble

@WalshyDev WalshyDev

@kodster28 kodster28

@marciocloudflare marciocloudflare

@haleycode haleycode

Labels

product:style-guide size/m

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.