Skip to content

Commit 4363b51

Browse files
committed
fix: update documentation links to use relative paths
1 parent 2f56082 commit 4363b51

9 files changed

Lines changed: 45 additions & 45 deletions

File tree

docs/api-reference/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Complete technical reference for every class, method, and model in StakeAPI.
1818

1919
| Module | Description |
2020
|:-------|:------------|
21-
| [StakeAPI Client]({% link docs/api-reference/client.md %}) | Main client class — all API methods |
22-
| [AuthManager]({% link docs/api-reference/auth-manager.md %}) | Authentication and token management |
23-
| [Data Models]({% link docs/api-reference/models.md %}) | Pydantic models for typed responses |
24-
| [Endpoints]({% link docs/api-reference/endpoints.md %}) | API endpoint constants and GraphQL queries |
25-
| [Exceptions]({% link docs/api-reference/exceptions.md %}) | Error types and exception hierarchy |
26-
| [Utilities]({% link docs/api-reference/utilities.md %}) | Helper functions and validators |
21+
| [StakeAPI Client]({% link api-reference/client.md %}) | Main client class — all API methods |
22+
| [AuthManager]({% link api-reference/auth-manager.md %}) | Authentication and token management |
23+
| [Data Models]({% link api-reference/models.md %}) | Pydantic models for typed responses |
24+
| [Endpoints]({% link api-reference/endpoints.md %}) | API endpoint constants and GraphQL queries |
25+
| [Exceptions]({% link api-reference/exceptions.md %}) | Error types and exception hierarchy |
26+
| [Utilities]({% link api-reference/utilities.md %}) | Helper functions and validators |
2727

2828
All API methods require a valid [Stake.com account](https://stake.com/?c=WY7953wQ) and access token.
2929

docs/getting-started/authentication.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -230,9 +230,9 @@ if auth.is_token_expired():
230230

231231
Now that you're authenticated, make your first API call:
232232

233-
- [Quick Start Guide]({% link docs/getting-started/quickstart.md %}) — Your first API call in 30 seconds
234-
- [User Account API]({% link docs/guides/user-account.md %}) — Get your profile and balance
235-
- [Casino Games API]({% link docs/guides/casino-games.md %}) — Browse available games
233+
- [Quick Start Guide]({% link getting-started/quickstart.md %}) — Your first API call in 30 seconds
234+
- [User Account API]({% link guides/user-account.md %}) — Get your profile and balance
235+
- [Casino Games API]({% link guides/casino-games.md %}) — Browse available games
236236

237237
---
238238

docs/getting-started/installation.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -133,8 +133,8 @@ StakeAPI version: 0.1.0
133133
Now that StakeAPI is installed, you need a Stake.com account and access token:
134134

135135
- [Sign up on Stake.com](https://stake.com/?c=WY7953wQ) if you don't have an account
136-
- [Authentication Guide]({% link docs/getting-started/authentication.md %}) — Learn how to get your access token
137-
- [Quick Start]({% link docs/getting-started/quickstart.md %}) — Make your first API call
136+
- [Authentication Guide]({% link getting-started/authentication.md %}) — Learn how to get your access token
137+
- [Quick Start]({% link getting-started/quickstart.md %}) — Make your first API call
138138

139139
{% include affiliate-banner.html %}
140140
{% include discord-cta.html %}

docs/getting-started/quickstart.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -172,12 +172,12 @@ Now that you've made your first API call, explore the full power of StakeAPI:
172172

173173
| Guide | Description |
174174
|:------|:------------|
175-
| [Casino Games]({% link docs/guides/casino-games.md %}) | Browse and analyze casino games |
176-
| [Sports Betting]({% link docs/guides/sports-betting.md %}) | Access sports events and odds |
177-
| [User Account]({% link docs/guides/user-account.md %}) | Manage your profile and balance |
178-
| [Betting API]({% link docs/guides/betting.md %}) | Place bets and track history |
179-
| [Advanced Usage]({% link docs/guides/advanced-usage.md %}) | Build analytics and automation tools |
180-
| [API Reference]({% link docs/api-reference/client.md %}) | Complete method documentation |
175+
| [Casino Games]({% link guides/casino-games.md %}) | Browse and analyze casino games |
176+
| [Sports Betting]({% link guides/sports-betting.md %}) | Access sports events and odds |
177+
| [User Account]({% link guides/user-account.md %}) | Manage your profile and balance |
178+
| [Betting API]({% link guides/betting.md %}) | Place bets and track history |
179+
| [Advanced Usage]({% link guides/advanced-usage.md %}) | Build analytics and automation tools |
180+
| [API Reference]({% link api-reference/client.md %}) | Complete method documentation |
181181

182182
---
183183

docs/guides/index.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -18,17 +18,17 @@ In-depth guides for every feature of StakeAPI.
1818

1919
| Guide | Description |
2020
|:------|:------------|
21-
| [Casino Games]({% link docs/guides/casino-games.md %}) | Browse games, filter by provider, analyze RTP data |
22-
| [Sports Betting]({% link docs/guides/sports-betting.md %}) | Live events, odds comparison, league data |
23-
| [User Account]({% link docs/guides/user-account.md %}) | Profile, balances, statistics, transactions |
24-
| [Betting]({% link docs/guides/betting.md %}) | Place bets, track history, manage wagers |
25-
| [GraphQL Queries]({% link docs/guides/graphql-queries.md %}) | Use raw GraphQL for maximum flexibility |
26-
| [Error Handling]({% link docs/guides/error-handling.md %}) | Handle errors gracefully in production apps |
27-
| [Rate Limiting]({% link docs/guides/rate-limiting.md %}) | Stay within API limits and optimize throughput |
28-
| [WebSockets]({% link docs/guides/websockets.md %}) | Real-time data streams and live updates |
29-
| [Advanced Usage]({% link docs/guides/advanced-usage.md %}) | Analytics, batch operations, and automation |
30-
| [Security]({% link docs/guides/security.md %}) | Best practices for securing your application |
31-
| [Performance]({% link docs/guides/performance.md %}) | Optimize your StakeAPI integration |
21+
| [Casino Games]({% link guides/casino-games.md %}) | Browse games, filter by provider, analyze RTP data |
22+
| [Sports Betting]({% link guides/sports-betting.md %}) | Live events, odds comparison, league data |
23+
| [User Account]({% link guides/user-account.md %}) | Profile, balances, statistics, transactions |
24+
| [Betting]({% link guides/betting.md %}) | Place bets, track history, manage wagers |
25+
| [GraphQL Queries]({% link guides/graphql-queries.md %}) | Use raw GraphQL for maximum flexibility |
26+
| [Error Handling]({% link guides/error-handling.md %}) | Handle errors gracefully in production apps |
27+
| [Rate Limiting]({% link guides/rate-limiting.md %}) | Stay within API limits and optimize throughput |
28+
| [WebSockets]({% link guides/websockets.md %}) | Real-time data streams and live updates |
29+
| [Advanced Usage]({% link guides/advanced-usage.md %}) | Analytics, batch operations, and automation |
30+
| [Security]({% link guides/security.md %}) | Best practices for securing your application |
31+
| [Performance]({% link guides/performance.md %}) | Optimize your StakeAPI integration |
3232

3333
Each guide includes working code examples you can copy and modify. All examples assume you have a [Stake.com account](https://stake.com/?c=WY7953wQ) and a valid access token.
3434

docs/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ permalink: /
1212
The most powerful unofficial Python wrapper for the Stake.com API. Build bots, analytics dashboards, and automation tools with ease.
1313
{: .fs-6 .fw-300 }
1414

15-
[Get Started]({% link docs/getting-started/installation.md %}){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
15+
[Get Started]({% link getting-started/installation.md %}){: .btn .btn-primary .fs-5 .mb-4 .mb-md-0 .mr-2 }
1616
[View on GitHub](https://github.com/chipadevteam/StakeAPI){: .btn .fs-5 .mb-4 .mb-md-0 }
1717
[Sign Up on Stake.com](https://stake.com/?c=WY7953wQ){: .btn .btn-green .fs-5 .mb-4 .mb-md-0 }
1818

@@ -113,8 +113,8 @@ StakeAPI supports Python 3.8 and above:
113113
## Community & Support
114114

115115
- [GitHub Issues](https://github.com/chipadevteam/StakeAPI/issues) — Report bugs and request features
116-
- [Contributing Guide]({% link docs/resources/contributing.md %}) — Learn how to contribute
117-
- [Changelog]({% link docs/resources/changelog.md %}) — See what's new
116+
- [Contributing Guide]({% link resources/contributing.md %}) — Learn how to contribute
117+
- [Changelog]({% link resources/changelog.md %}) — See what's new
118118
- [Discord Server](https://discord.gg/PHHfh6UyCb) — Join the community, get help, and share your projects
119119

120120
{% include affiliate-banner.html %}
@@ -131,4 +131,4 @@ The fastest way to get started is to [create a Stake.com account](https://stake.
131131
pip install stakeapi
132132
```
133133

134-
Then head to the [Installation Guide]({% link docs/getting-started/installation.md %}) for detailed setup instructions.
134+
Then head to the [Installation Guide]({% link getting-started/installation.md %}) for detailed setup instructions.

docs/resources/faq.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ Python 3.8 and above (3.8, 3.9, 3.10, 3.11, 3.12).
4646
5. Find a request to `/_api/graphql`
4747
6. Copy the `x-access-token` header value
4848

49-
See the [Authentication Guide]({% link docs/getting-started/authentication.md %}) for detailed instructions.
49+
See the [Authentication Guide]({% link getting-started/authentication.md %}) for detailed instructions.
5050

5151
### Do I need a Stake.com account?
5252

@@ -58,7 +58,7 @@ Yes. You need a [Stake.com account](https://stake.com/?c=WY7953wQ) to get an acc
5858
pip install stakeapi
5959
```
6060

61-
See the [Installation Guide]({% link docs/getting-started/installation.md %}) for more options.
61+
See the [Installation Guide]({% link getting-started/installation.md %}) for more options.
6262

6363
---
6464

@@ -104,7 +104,7 @@ client2 = StakeAPI(access_token="token_account_2")
104104

105105
### Is there a rate limit?
106106

107-
Yes. Stake.com enforces rate limits. The default is 10 requests/second. See the [Rate Limiting Guide]({% link docs/guides/rate-limiting.md %}).
107+
Yes. Stake.com enforces rate limits. The default is 10 requests/second. See the [Rate Limiting Guide]({% link guides/rate-limiting.md %}).
108108

109109
### Can I place bets with the API?
110110

@@ -116,7 +116,7 @@ The current version does not support deposits or withdrawals for security reason
116116

117117
### Does StakeAPI support WebSockets?
118118

119-
Yes! See the [WebSocket Guide]({% link docs/guides/websockets.md %}) for real-time data streaming.
119+
Yes! See the [WebSocket Guide]({% link guides/websockets.md %}) for real-time data streaming.
120120

121121
---
122122

@@ -150,7 +150,7 @@ StakeAPI pins known endpoints. If Stake.com changes their API, you may need to u
150150

151151
### Is my data safe?
152152

153-
StakeAPI communicates exclusively over HTTPS. Your tokens are never stored or transmitted to third parties. See the [Security Guide]({% link docs/guides/security.md %}).
153+
StakeAPI communicates exclusively over HTTPS. Your tokens are never stored or transmitted to third parties. See the [Security Guide]({% link guides/security.md %}).
154154

155155
---
156156

@@ -172,7 +172,7 @@ Make sure your account has the relevant data (bets, balance, etc.). Some endpoin
172172

173173
Make sure you're using `async with` or calling `await client.close()`. Check your timeout settings.
174174

175-
For more issues, see the [Troubleshooting Guide]({% link docs/resources/troubleshooting.md %}).
175+
For more issues, see the [Troubleshooting Guide]({% link resources/troubleshooting.md %}).
176176

177177
{% include affiliate-banner.html %}
178178
{% include discord-cta.html %}

docs/resources/index.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@ Examples, FAQ, troubleshooting, and everything else you need.
1818

1919
| Resource | Description |
2020
|:---------|:------------|
21-
| [Examples]({% link docs/resources/examples.md %}) | Ready-to-run code examples |
22-
| [FAQ]({% link docs/resources/faq.md %}) | Frequently asked questions |
23-
| [Troubleshooting]({% link docs/resources/troubleshooting.md %}) | Common issues and solutions |
24-
| [Changelog]({% link docs/resources/changelog.md %}) | Version history and release notes |
25-
| [Contributing]({% link docs/resources/contributing.md %}) | How to contribute to StakeAPI |
26-
| [Migration Guide]({% link docs/resources/migration.md %}) | Upgrading between versions |
21+
| [Examples]({% link resources/examples.md %}) | Ready-to-run code examples |
22+
| [FAQ]({% link resources/faq.md %}) | Frequently asked questions |
23+
| [Troubleshooting]({% link resources/troubleshooting.md %}) | Common issues and solutions |
24+
| [Changelog]({% link resources/changelog.md %}) | Version history and release notes |
25+
| [Contributing]({% link resources/contributing.md %}) | How to contribute to StakeAPI |
26+
| [Migration Guide]({% link resources/migration.md %}) | Upgrading between versions |
2727

2828
{% include affiliate-cta.html %}
2929
{% include discord-cta.html %}

docs/resources/troubleshooting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -262,7 +262,7 @@ balance = asyncio.run(main())
262262

263263
## Still Stuck?
264264

265-
1. Check the [FAQ]({% link docs/resources/faq.md %})
265+
1. Check the [FAQ]({% link resources/faq.md %})
266266
2. Search [GitHub Issues](https://github.com/chipadevteam/StakeAPI/issues)
267267
3. Open a new issue with:
268268
- StakeAPI version

0 commit comments

Comments
 (0)