Skip to content

docs: broken links#4227

Merged
chronark merged 1 commit intomainfrom
11-04-docs_broken_links
Nov 4, 2025
Merged

docs: broken links#4227
chronark merged 1 commit intomainfrom
11-04-docs_broken_links

Conversation

@chronark
Copy link
Collaborator

@chronark chronark commented Nov 4, 2025

What does this PR do?

Fixes # (issue)

If there is not an issue for this, please create one first. This is used to tracking purposes and also helps us understand why this PR exists

Type of change

  • Bug fix (non-breaking change which fixes an issue)
  • Chore (refactoring code, technical debt, workflow improvements)
  • Enhancement (small improvements)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • This change requires a documentation update

How should this be tested?

  • Test A
  • Test B

Checklist

Required

  • Filled out the "How to test" section in this PR
  • Read Contributing Guide
  • Self-reviewed my own code
  • Commented on my code in hard-to-understand areas
  • Ran pnpm build
  • Ran pnpm fmt
  • Ran make fmt on /go directory
  • Checked for warnings, there are none
  • Removed all console.logs
  • Merged the latest changes from main onto my branch with git pull origin main
  • My changes don't cause any responsiveness issues

Appreciated

  • If a UI change was made: Added a screen recording or screenshots to this PR
  • Updated the Unkey Docs if changes were necessary

@vercel
Copy link

vercel bot commented Nov 4, 2025

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Preview Comments Updated (UTC)
dashboard Ready Ready Preview Comment Nov 4, 2025 4:50pm
engineering Ready Ready Preview Comment Nov 4, 2025 4:50pm

@changeset-bot
Copy link

changeset-bot bot commented Nov 4, 2025

⚠️ No Changeset found

Latest commit: 553383e

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@chronark chronark marked this pull request as ready for review November 4, 2025 16:50
@coderabbitai
Copy link
Contributor

coderabbitai bot commented Nov 4, 2025

Caution

Review failed

The pull request is closed.

📝 Walkthrough

Walkthrough

Documentation-only changes updating multiple internal API reference links to v2 (and a few v1) paths across docs; one doc (roles-and-permissions) also expands the UI narrative and adds Frame-wrapped images.

Changes

Cohort / File(s) Summary
Auth API reference links
apps/docs/ai-code-gen/unkey-mcp.mdx, apps/docs/quickstart/onboarding/onboarding-api.mdx
Updated authentication API links from /api-reference/authentication (and /api-reference/auth) to /api-reference/v2/auth.
Keys API reference links
apps/docs/apis/features/temp-keys.mdx, apps/docs/libraries/ts/hono.mdx
Repointed key-related references to /api-reference/v2/keys/create-api-key; adjusted an internal setup anchor from /app/api/settings/root-keys.
Rate limiting API reference links
apps/docs/quickstart/onboarding/onboarding-ratelimiting.mdx, apps/docs/ratelimiting/introduction.mdx, apps/docs/ratelimiting/automated-overrides.mdx
Replaced /api-reference/ratelimits/* links with /api-reference/v2/overview.
Roles & permissions documentation expansion
apps/docs/apis/features/authorization/roles-and-permissions.mdx
Added expanded UI narrative under “Connecting roles to keys”, inserted Frame-wrapped images/screenshots, small formatting fixes, and updated key-create link to /api-reference/v2/keys/create-api-key.
Migration & miscellaneous links
apps/docs/migrations/keys.mdx, apps/docs/libraries/nuxt/overview.mdx, apps/docs/security/recovering-keys.mdx
Updated migration link to /api-reference/v1/migration/keys, changed TS client anchor from overview to API docs (/libraries/ts/api), and adjusted recovering-keys endpoint links to v2 overview paths.

Sequence Diagram(s)

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

  • Check that updated links resolve to the intended docs pages.
  • Review roles-and-permissions.mdx framing/markdown for proper rendering of added Frame image blocks.

Possibly related PRs

Suggested labels

Documentation, Needs Approval

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch 11-04-docs_broken_links

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 30a9d3e and 553383e.

📒 Files selected for processing (11)
  • apps/docs/ai-code-gen/unkey-mcp.mdx (1 hunks)
  • apps/docs/apis/features/authorization/roles-and-permissions.mdx (2 hunks)
  • apps/docs/apis/features/temp-keys.mdx (1 hunks)
  • apps/docs/libraries/nuxt/overview.mdx (1 hunks)
  • apps/docs/libraries/ts/hono.mdx (2 hunks)
  • apps/docs/migrations/keys.mdx (1 hunks)
  • apps/docs/quickstart/onboarding/onboarding-api.mdx (1 hunks)
  • apps/docs/quickstart/onboarding/onboarding-ratelimiting.mdx (1 hunks)
  • apps/docs/ratelimiting/automated-overrides.mdx (4 hunks)
  • apps/docs/ratelimiting/introduction.mdx (1 hunks)
  • apps/docs/security/recovering-keys.mdx (1 hunks)

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Copy link
Collaborator Author

chronark commented Nov 4, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@vercel vercel bot temporarily deployed to Preview – engineering November 4, 2025 16:50 Inactive
@vercel vercel bot temporarily deployed to Preview – dashboard November 4, 2025 16:50 Inactive
@chronark chronark mentioned this pull request Nov 4, 2025
19 tasks
@chronark chronark merged commit 753bd0e into main Nov 4, 2025
27 of 28 checks passed
@chronark chronark deleted the 11-04-docs_broken_links branch November 4, 2025 16:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant