Fix v1 introduction links#9
Conversation
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Code Review
This pull request replaces relative internal documentation links with absolute URLs pointing to the production domain. The reviewer recommends reverting these changes in favor of relative paths, as absolute URLs break local and staging preview environments and create inconsistencies with other links in the project.
|
|
||
| <Warning> | ||
| The v0 API is the legacy version of the Top.gg API. **New integrations should use the [v1 API](/api/v1/introduction)** instead. The v0 API may not receive new features and could be deprecated in a future release. | ||
| The v0 API is the legacy version of the Top.gg API. **New integrations should use the [v1 API](https://docs.top.gg/api/v1/introduction)** instead. The v0 API may not receive new features and could be deprecated in a future release. |
There was a problem hiding this comment.
Using absolute URLs for internal documentation links is generally discouraged as it breaks local previews and staging environments (e.g., PR previews on Vercel or Netlify). Using a relative path like ../v1/introduction ensures the link remains environment-agnostic and consistent across different deployments.
The v0 API is the legacy version of the Top.gg API. **New integrations should use the [v1 API](../v1/introduction)** instead. The v0 API may not receive new features and could be deprecated in a future release.
|
|
||
| <Note> | ||
| Do not include a `Bearer` prefix. v0 tokens are passed as a raw string. Bearer-prefixed tokens are only valid on [v1 endpoints](/api/v1/introduction). | ||
| Do not include a `Bearer` prefix. v0 tokens are passed as a raw string. Bearer-prefixed tokens are only valid on [v1 endpoints](https://docs.top.gg/api/v1/introduction). |
There was a problem hiding this comment.
Using absolute URLs for internal links breaks environment-agnostic navigation. Consider using a relative path instead to support local development and preview environments.
Do not include a `Bearer` prefix. v0 tokens are passed as a raw string. Bearer-prefixed tokens are only valid on [v1 endpoints](../v1/introduction).
| Receive real-time vote notifications sent directly to your server. | ||
| </Card> | ||
| <Card title="API Reference" icon="code" href="/api/v1/introduction"> | ||
| <Card title="API Reference" icon="code" href="https://docs.top.gg/api/v1/introduction"> |
There was a problem hiding this comment.
Hardcoding the absolute production URL breaks preview environments and is inconsistent with other links in this file (e.g., the 'Webhooks' card on line 15). If the root-relative path was reported as broken, it might be worth checking if a trailing slash or a path relative to the root (e.g., api/v1/introduction) resolves the issue while keeping the link environment-agnostic.
1 participant
Summary
mint broken-linksTests
npx mint broken-links