From 784a8de78aeba26a4a49ebacd099134572ee1a3e Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Tue, 2 Aug 2022 19:05:02 +0100 Subject: [PATCH] fix(docs): fix tachi-common, tachi-database-seeds links and capitalise properly --- docs/docs/api/overview.md | 4 +- docs/docs/api/routes/gpt.md | 2 +- docs/docs/contributing.md | 2 +- docs/docs/tachi-bot/overview.md | 2 +- docs/docs/tachi-server/documents/overview.md | 2 +- .../game-configuration.md | 2 +- .../infrastructure/database-seeds.md | 2 +- docs/docs/tachi-server/overview.md | 43 +++---------------- 8 files changed, 13 insertions(+), 46 deletions(-) diff --git a/docs/docs/api/overview.md b/docs/docs/api/overview.md index c67ff5bb1..76a2fb43d 100644 --- a/docs/docs/api/overview.md +++ b/docs/docs/api/overview.md @@ -35,7 +35,7 @@ for API abuse. ## License -[Tachi-Server](https://github.com/tng-dev/tachi/tree/staging/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/TNG-dev/Tachi/tree/staging/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/tng-dev/tachi). I'll get around to either. +[Issue Tracker](https://github.com/TNG-dev/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! diff --git a/docs/docs/api/routes/gpt.md b/docs/docs/api/routes/gpt.md index 024222a82..11c1b766a 100644 --- a/docs/docs/api/routes/gpt.md +++ b/docs/docs/api/routes/gpt.md @@ -570,7 +570,7 @@ GET /api/v1/games/bms/7K/player-distribution?class=stslDan !!! info You can find the humanised conversions for these classes in the gptConfig for this GPT. - See [tachi-common](https://github.com/tng-dev/tachi-common) for more information. + See [tachi/common](https://github.com/TNG-dev/Tachi/tree/staging/common) for more information. ***** diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md index 4d9e6b458..eae155546 100644 --- a/docs/docs/contributing.md +++ b/docs/docs/contributing.md @@ -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), and +the [GitHub](https://github.com/TNG-dev/Tachi), and fork the repository. ## Non-Code Contributions diff --git a/docs/docs/tachi-bot/overview.md b/docs/docs/tachi-bot/overview.md index c93e74f31..110d7e8d5 100644 --- a/docs/docs/tachi-bot/overview.md +++ b/docs/docs/tachi-bot/overview.md @@ -1,5 +1,5 @@ # Bot Overview -This part of the documentation is for the [Tachi-Bot](https://github.com/tng-dev/tachi/tree/staging/bot). +This part of the documentation is for the [Tachi-Bot](https://github.com/TNG-dev/Tachi/tree/staging/bot). At the moment, it's empty. I'll get around to filling it out soon. diff --git a/docs/docs/tachi-server/documents/overview.md b/docs/docs/tachi-server/documents/overview.md index abbc6369e..16c413693 100644 --- a/docs/docs/tachi-server/documents/overview.md +++ b/docs/docs/tachi-server/documents/overview.md @@ -18,7 +18,7 @@ shape of those documents. to this, please see [Contributing](../contributing.md). If you need information on a document that is not specified here, - You will have to check [tachi-common](https://github.com/tng-dev/tachi-common) manually. + You will have to check [tachi-common](https://github.com/TNG-dev/Tachi/tree/staging/common) manually. Sorry! ***** diff --git a/docs/docs/tachi-server/implementation-details/game-configuration.md b/docs/docs/tachi-server/implementation-details/game-configuration.md index 5202aded8..24e798565 100644 --- a/docs/docs/tachi-server/implementation-details/game-configuration.md +++ b/docs/docs/tachi-server/implementation-details/game-configuration.md @@ -19,4 +19,4 @@ lamps for the game. ***** -This documentation is unfinished. It is probably easier for you to [just read the config.ts file](https://github.com/tng-dev/tachi-common/tree/master/src/config/config.ts) \ No newline at end of file +This documentation is unfinished. It is probably easier for you to [just read the config.ts file](https://github.com/TNG-dev/Tachi/tree/staging/common/src/config/config.ts) \ No newline at end of file diff --git a/docs/docs/tachi-server/infrastructure/database-seeds.md b/docs/docs/tachi-server/infrastructure/database-seeds.md index c3b4e5f2f..18b721858 100644 --- a/docs/docs/tachi-server/infrastructure/database-seeds.md +++ b/docs/docs/tachi-server/infrastructure/database-seeds.md @@ -1,6 +1,6 @@ # Database Seeds -Tachi uses a separate git repository called the [Database Seeds](https://github.com/tng-dev/tachi-database-seeds) to maintain 'static' databases. +Tachi uses a separate git repository called the [Database Seeds](https://github.com/TNG-dev/Tachi/tree/staging/database-seeds) to maintain 'static' databases. The databases in question aren't (normally) altered by the server code. We essentially overload git and its CI tools to version control parts of our database. diff --git a/docs/docs/tachi-server/overview.md b/docs/docs/tachi-server/overview.md index 40017d488..8d7fae7f9 100644 --- a/docs/docs/tachi-server/overview.md +++ b/docs/docs/tachi-server/overview.md @@ -1,12 +1,6 @@ # Codebase Overview -This part of the documentation is for the [Tachi-Server](https://github.com/tng-dev/tachi/tree/staging/server) codebase. - -!!! info - This is *ONLY* documentation for `tachi-server`. - - As mentioned below, `tachi-client` is closed source, - and does not have public codebase documentation. +This part of the documentation is for the [Tachi-Server](https://github.com/TNG-dev/Tachi/tree/staging/server) codebase. ## Codebase Documentation vs. Code Documentation @@ -23,34 +17,7 @@ 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/tng-dev/tachi/tree/staging/common). This is licensed under MIT. -- `tachi-server`: The API, IR implementations and 'business logic' behind Tachi. [GitHub](https://github.com/tng-dev/tachi/tree/staging/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/tng-dev/tachi/tree/staging/docs). This is licensed under MIT. - -### What's with `tachi-client`? - -The original plan was to have the entire codebase be open source. However, I've decided to make the -front-end code for Tachi be closed source. This is to reduce the amount of low-effort forks Tachi -may receive by virtue of being open source. - -Other rhythm game projects as of recently have had a massive influx of low-effort forks that just -change the name of the project, rehost it, break the license, and don't upload any code back upstream. - -It's disheartening, and the reason that the client is not publically available. - -I picked the server code instead of the client code to open source because I think it's of significantly -more interest to other programmers in the scene. - -### Why even bother with open source then? - -I'm proud of the code, and I think other people will be interested in it. - -Also, it's nice to give back to the community. - -### What's with `tachi-common`? - -Some things are common between the client and server. -It's pretty much just one very large types.ts file that needs to be split up. - - +- `tachi-common`: Common types and values for Tachi. [GitHub](https://github.com/TNG-dev/Tachi/tree/staging/common). This is licensed under MIT. +- `tachi-server`: The API, IR implementations and 'business logic' behind Tachi. [GitHub](https://github.com/TNG-dev/Tachi/tree/staging/server). This is licensed under AGPLv3. +- `tachi-client`: The front-end code for Tachi. [GitHub](https://github.com/TNG-dev/Tachi/tree/staging/client). This is licensed under AGPLv3.. +- `tachi-docs`: The documentation you're reading right now! [GitHub](https://github.com/TNG-dev/Tachi/tree/staging/docs). This is licensed under MIT.