Merge pull request #615 from j1nxie/docs-cleanup

This commit is contained in:
zkldi
2022-08-02 16:18:02 +01:00
committed by GitHub
6 changed files with 11 additions and 11 deletions
@@ -74,7 +74,7 @@ export function Footer() {
</a>
)}
<a
href="https://github.com/tng-dev/tachi-server"
href="https://github.com/tng-dev/tachi"
target="_blank"
rel="noopener noreferrer"
className="nav-link px-3"
+3 -3
View File
@@ -35,7 +35,7 @@ for API abuse.
## License
[Tachi-Server](https://github.com/zkldi/tachi-server) (Where the API is wrote) is licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html).
[Tachi-Server](https://github.com/zkldi/tachi/server) (Where the API is wrote) is licensed under the [AGPLv3](https://www.gnu.org/licenses/agpl-3.0.en.html).
To quote GitHub:
@@ -96,7 +96,7 @@ The HTTP Status Code for any Failed Response will always be of either 4XX or 5XX
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
[Issue Tracker](https://github.com/zkldi/tachi-docs). I'll get around to either.
[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
of something, so please reach out!
of something, so please reach out!
+1 -1
View File
@@ -24,7 +24,7 @@ logic in the codebase) may be subject to some more scrutiny
to make sure that they are correct, but are also significantly appreciated.
To contribute to the documentation, you should go to
the [GitHub](https://github.com/tng-dev/tachi-docs), and
the [GitHub](https://github.com/tng-dev/tachi/docs), and
fork the repository.
## Non-Code Contributions
+1 -1
View File
@@ -1,5 +1,5 @@
# Bot Overview
This part of the documentation is for the [Tachi-Bot](https://github.com/tng-dev/tachi-bot).
This part of the documentation is for the [Tachi-Bot](https://github.com/tng-dev/tachi/bot).
At the moment, it's empty. I'll get around to filling it out soon.
@@ -175,4 +175,4 @@ looks like this:
}
}]
}
```
```
+4 -4
View File
@@ -1,6 +1,6 @@
# Codebase Overview
This part of the documentation is for the [Tachi-Server](https://github.com/zkldi/tachi-server) codebase.
This part of the documentation is for the [Tachi-Server](https://github.com/zkldi/tachi/server) codebase.
!!! info
This is *ONLY* documentation for `tachi-server`.
@@ -23,10 +23,10 @@ correspond to, how `thing` works, etc.
Tachi is made up of four components:
- `tachi-common`: Common types and values for Tachi. [GitHub](https://github.com/zkldi/tachi-common). This is licensed under MIT.
- `tachi-server`: The API, IR implementations and 'business logic' behind Tachi. [GitHub](https://github.com/zkldi/tachi-server). This is licensed under AGPLv3.
- `tachi-common`: Common types and values for Tachi. [GitHub](https://github.com/zkldi/tachi/common). This is licensed under MIT.
- `tachi-server`: The API, IR implementations and 'business logic' behind Tachi. [GitHub](https://github.com/zkldi/tachi/server). This is licensed under AGPLv3.
- `tachi-client`: The front-end code for Tachi. This is closed source.
- `tachi-docs`: The documentation you're reading right now! [GitHub](https://github.com/zkldi/tachi-docs). This is licensed under MIT.
- `tachi-docs`: The documentation you're reading right now! [GitHub](https://github.com/zkldi/tachi/docs). This is licensed under MIT.
### What's with `tachi-client`?