Skip to content

Add cross-references to API reference docs #22146

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.

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

Merged
merged 2 commits into from
May 5, 2025

Conversation

jhutchings1
Copy link
Contributor

Summary

I noticed that we don't have cross-references to the various API docs in the fundamentals section right now. I've added these to improve discoverability and navigation. I also changed the order to alphabetize the rest of the reference content in this folder.

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.

@jhutchings1 jhutchings1 requested review from dcpena and a team as code owners May 1, 2025 21:08
Copy link
Contributor

hyperlint-ai bot commented May 1, 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 API documentation by adding cross-references and reorganizing content for better navigation.

  • Added cross-references to various API docs in the fundamentals section
  • Alphabetized the order of reference content
  • Introduced new GraphQL and REST API documentation pages
  • Updated sidebar order for existing API reference pages

Modified Files

  • src/content/docs/fundamentals/api/reference/deprecations.mdx
  • src/content/docs/fundamentals/api/reference/limits.mdx
  • src/content/docs/fundamentals/api/reference/permissions.mdx
  • src/content/docs/fundamentals/api/reference/sdks.mdx
  • src/content/docs/fundamentals/api/reference/template.mdx

Added Files

  • src/content/docs/fundamentals/api/reference/graphql-api.mdx
  • src/content/docs/fundamentals/api/reference/rest-api.mdx
  • src/content/docs/fundamentals/api/reference/wrangler-api.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.

Copy link
Contributor

github-actions bot commented May 1, 2025

Preview URL: https://2e05645d.preview.developers.cloudflare.com
Preview Branch URL: https://jhutchings1-api-reference.preview.developers.cloudflare.com

Files with changes (up to 15)

Original Link Updated Link
https://developers.cloudflare.com/fundamentals/api/reference/template/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/template/
https://developers.cloudflare.com/fundamentals/api/reference/graphql-api/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/graphql-api/
https://developers.cloudflare.com/fundamentals/api/reference/limits/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/limits/
https://developers.cloudflare.com/fundamentals/api/reference/rest-api/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/rest-api/
https://developers.cloudflare.com/fundamentals/api/reference/wrangler-api/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/wrangler-api/
https://developers.cloudflare.com/fundamentals/api/reference/deprecations/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/deprecations/
https://developers.cloudflare.com/fundamentals/api/reference/permissions/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/permissions/
https://developers.cloudflare.com/fundamentals/api/reference/sdks/ https://jhutchings1-api-reference.preview.developers.cloudflare.com/fundamentals/api/reference/sdks/

@jhutchings1
Copy link
Contributor Author

@KianNH any ideas why these Actions workflows are failing on this PR? Not sure if I should ignore?

@github-actions github-actions bot added the size/m label May 5, 2025
@jhutchings1 jhutchings1 merged commit 2d696ec into production May 5, 2025
15 checks passed
@jhutchings1 jhutchings1 deleted the jhutchings1-api-reference branch May 5, 2025 16:36
@jhutchings1
Copy link
Contributor Author

Workflows all passed when I reran them today. Thanks!

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