Skip to content

Commit

Permalink
docs: various improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
zkrising committed May 14, 2024
1 parent 7f5b3c3 commit b42a6b3
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
5 changes: 2 additions & 3 deletions docs/docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,7 @@ The API has a rate limit of 500 requests every minute. This is a very
generous rate limit, and you should not even be close to hitting it.

If you are in a scenario where you might be hitting even 100 requests a minute consistently,
please contact me at `zkldi#2965`. Otherwise, you might have your tokens revoked
for API abuse.
send an email to `zk@tachi.ac` and let me know what you're up to. Otherwise, I might revoke your tokens for abuse.

## License

Expand Down Expand Up @@ -95,7 +94,7 @@ The HTTP Status Code for any Failed Response will always be of either 4XX or 5XX
## Footnote

That should be everything. If you have any questions about the API, you can
contact me on discord at `zkldi#2965`. You can also write an issue on the
contact me at `zk@tachi.ac`. You can also write an issue on the
[Issue Tracker](https://github.com/zkldi/Tachi). I'll get around to either.

It's entirely possible that I might've made a typo or wrote a poor explaination
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/api/routes/users.md
Original file line number Diff line number Diff line change
Expand Up @@ -144,7 +144,7 @@ GET /api/v1/users/me IF authenticated as userID 1.
"twitter": null,
"steam": "zkldi",
// this property was already here, and not modified by the request.
"discord": "zkldi#2965",
"discord": "chatbpd",
},
"about": "#Hello!**I'm zkldi**",
"status": "I'm cool!",
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ to it. See the [Contribution Guide](./contributing)!
This is for end user reference, such as score importing tutorials, documentation on tachi's
statistics. It requires no programming knowledge, and is mostly used as a wiki-like reference.

View it [here](./user).
View it [here](./wiki).

*****

Expand Down
4 changes: 4 additions & 0 deletions docs/docs/wiki/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,8 @@ using any distribution of Tachi.

The rules can be found [here](./rules.md).

## I have a bug report or feature request.

Please reach out on discord or [GitHub Issues](https://github.com/zkldi/Tachi)!

--8<-- "includes/abbreviations.md"

0 comments on commit b42a6b3

Please sign in to comment.