-
Notifications
You must be signed in to change notification settings - Fork 0
Fix v1 introduction links #9
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
base: main
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -7,7 +7,7 @@ description: "The Top.gg v0 legacy API provides bot and user endpoints at https: | |
| The v0 API is the original Top.gg REST API. It remains available for existing integrations but is considered legacy. It covers bot search and stats endpoints, user lookups, and vote tracking. | ||
|
|
||
| <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. | ||
| </Warning> | ||
|
|
||
| ## Base URL | ||
|
|
@@ -34,7 +34,7 @@ curl https://top.gg/api/bots/YOUR_BOT_ID \ | |
| ``` | ||
|
|
||
| <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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Using absolute URLs for internal links breaks environment-agnostic navigation. Consider using a relative path instead to support local development and preview environments. |
||
| </Note> | ||
|
|
||
| ## Rate limits | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -15,7 +15,7 @@ Top.gg is the largest discovery platform for Discord bots and servers. As a deve | |
| <Card title="Webhooks" icon="bolt" href="/webhooks/overview"> | ||
| 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. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. 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., |
||
| Full reference for all v1 and legacy v0 REST API endpoints. | ||
| </Card> | ||
| </CardGroup> | ||
|
|
||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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/introductionensures the link remains environment-agnostic and consistent across different deployments.