diff --git a/docs/docs/api/auth.md b/docs/docs/api/auth.md index d7ee3fcb7..e4a765112 100644 --- a/docs/docs/api/auth.md +++ b/docs/docs/api/auth.md @@ -34,7 +34,7 @@ permissions over API Tokens, such as being able to change your password. ## Getting Tokens -[Our OAuth2 Flow](../codebase/infrastructure/oauth2.md) should be used to acquire API Tokens. +[Our OAuth2 Flow](../tachi-server/infrastructure/oauth2.md) should be used to acquire API Tokens. ## Permissions diff --git a/docs/docs/api/routes/games.md b/docs/docs/api/routes/games.md index a9aa768ae..8e50cfff5 100644 --- a/docs/docs/api/routes/games.md +++ b/docs/docs/api/routes/games.md @@ -18,7 +18,7 @@ None. | Property | Type | Description | | :: | :: | :: | | `supportedGames` | String[] | The list of games this service supports. | -| `configs` | Record<Game, [GameConfig](../../codebase/implementation-details/game-configuration.md)> | Contains a mapping of every supported game to its configuration. | +| `configs` | Record<Game, [GameConfig](../../tachi-server/implementation-details/game-configuration.md)> | Contains a mapping of every supported game to its configuration. | ### Example diff --git a/docs/docs/api/routes/gpt.md b/docs/docs/api/routes/gpt.md index 4014891a3..b15a39e0f 100644 --- a/docs/docs/api/routes/gpt.md +++ b/docs/docs/api/routes/gpt.md @@ -22,7 +22,7 @@ None. !!! warning A GamePTConfig is different to a GameConfig! Read more - [here](../../codebase/implementation-details/game-configuration.md). + [here](../../tachi-server/implementation-details/game-configuration.md). ### Example diff --git a/docs/docs/api/routes/import.md b/docs/docs/api/routes/import.md index 6af3c7453..7e70b9fb8 100644 --- a/docs/docs/api/routes/import.md +++ b/docs/docs/api/routes/import.md @@ -27,7 +27,7 @@ appropriate way to send files. | HTTP Header | Description | | :: | :: | -| `X-User-Intent` (optional) | If this header is present, the request is assumed to have been sent with 'User Intent'. For more on this, see [Import Types](../../codebase/import/import-types.md) | +| `X-User-Intent` (optional) | If this header is present, the request is assumed to have been sent with 'User Intent'. For more on this, see [Import Types](../../tachi-server/import/import-types.md) | !!! info It's the responsibility of the API user to use the X-User-Intent diff --git a/docs/docs/api/routes/oauth2-clients.md b/docs/docs/api/routes/oauth2-clients.md index 0a1944a93..281d1aa3d 100644 --- a/docs/docs/api/routes/oauth2-clients.md +++ b/docs/docs/api/routes/oauth2-clients.md @@ -2,7 +2,7 @@ These endpoints relate to managing your OAuth2 clients, such as creating new ones or deleting them. -For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../codebase/infrastructure/oauth2.md) +For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../tachi-server/infrastructure/oauth2.md) ***** diff --git a/docs/docs/api/routes/oauth2.md b/docs/docs/api/routes/oauth2.md index 779e00787..0ab88f752 100644 --- a/docs/docs/api/routes/oauth2.md +++ b/docs/docs/api/routes/oauth2.md @@ -4,7 +4,7 @@ Tachi provides an OAuth2 API and some other things so that you can create your own clients and retrieve user api keys safely. -For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../codebase/infrastructure/oauth2.md) +For a detailed explaination on how to use the OAuth2 flow, you can check [Using OAuth2 With Tachi](../../tachi-server/infrastructure/oauth2.md) ***** diff --git a/docs/docs/api/routes/search.md b/docs/docs/api/routes/search.md index 28232fe82..b17916efb 100644 --- a/docs/docs/api/routes/search.md +++ b/docs/docs/api/routes/search.md @@ -17,7 +17,7 @@ | Property | Type | Description | | :: | :: | :: | | `users` | UserDocument[] | The array of users whose usernames look like the search criterion. | -| `songs` | (SongDocument With [__textScore](../../codebase/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. | +| `songs` | (SongDocument With [__textScore](../../tachi-server/implementation-details/search.md) and `game`.)[] | An array of songs from all games, with `__textScore` and `game` properties attached. | ### Example @@ -49,4 +49,4 @@ GET /api/v1/search?search=freedom ``` !!! info - For more details on how searching works, see [Search Implementation](../../codebase/implementation-details/search.md). + For more details on how searching works, see [Search Implementation](../../tachi-server/implementation-details/search.md). diff --git a/docs/docs/api/routes/user-gamept.md b/docs/docs/api/routes/user-gamept.md index 2a5d056f0..4f3951b20 100644 --- a/docs/docs/api/routes/user-gamept.md +++ b/docs/docs/api/routes/user-gamept.md @@ -224,7 +224,7 @@ GET /api/v1/users/zkldi/games/iidx/SP/pbs?search=Verfl `GET /api/v1/users/:userID/games/:game/:playtype/pbs/best` This returns the users' best 100 personal bests according -to the [Default Rating Algorithm](../../codebase/implementation-details/game-configuration) for this game. +to the [Default Rating Algorithm](../../tachi-server/implementation-details/game-configuration) for this game. This is returned in descending sorted order. @@ -363,7 +363,7 @@ GET /api/v1/users/1/games/iidx/SP/pbs/some_chart_id property. This property describes how close the query was to the actual text, and is mostly internal. - You can read more into the details of this at [Search Implementation](../../codebase/implementation-details/search.md) + You can read more into the details of this at [Search Implementation](../../tachi-server/implementation-details/search.md) ### Example diff --git a/docs/docs/contributing.md b/docs/docs/contributing.md new file mode 100644 index 000000000..84e1aa7a4 --- /dev/null +++ b/docs/docs/contributing.md @@ -0,0 +1,95 @@ +# Contributing to Tachi + +## For Newcomers + +If you're looking to contribute to Tachi but aren't +really familiar with TypeScript or other things +we use, Documentation Contributions are highly +appreciated, and accessible to do without any +programming knowledge. + +If you're not familiar with git, I would recommend +downloading [GitHub Desktop](https://desktop.github.com/). + +It has a nice, intuitive UI for making changes, and +saves the trouble of having to explain how forks work. + +## Documentation Contributions + +The documentation for Tachi may have typos, slight mistakes +or inconsistencies. Fixes for those are always appreciated. + +Larger documentation contributions (such as documenting +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/TeamNewGuys/tachi-docs), and +fork the repository. + +## Non-Code Contributions + +Inside the Discord Servers for Bokutachi and Kamaitachi is +a `#help-wanted` channel. This channel lists things that I +currently cannot do, either for time or knowledge reasons. + +These are not code related contributions, and can range from +cool images of cabinets/setups to milestones for a game. + +These are also significantly appreciated. + +## Code Contributions + +You should follow the code style of the project, and make issues before you make PRs! + +### Pull Requests + +You can contribute to `tachi` by forking +and then making your changes. + +There are a couple of strict guidelines to follow when +writing code contributions (Pull Requests). Not following these may +result in your pull request being rejected. + +- Write tests. + +Your new code should be tested if applicable. + +- Follow the style guide. + +Your new code should follow the style of the repo. The linter +should not have any errors. Generally, write code that +looks like it belongs. + +- Your PR should fix an issue. + +If there isn't an issue for your PR, you should make one +before making the PR. + +For larger PRs, such as making new features/new support, +you should make the issue in advance so discussion can +occur (so you don't waste your time on code that can't +be merged). + +### Issues + +Submitting issues to `tachi` is encouraged. Despite +the GitHub name of 'issues', issues may also be feature +requests, new support requests, and similar things. + +Guidelines for submitting issues are as follows: + +- Be Nice. + +Self-explanatory. Remember the human! + +- Make sure your issue isn't already reported as a duplicate. + +This saves me a lot of time. If there's a similar issue +but you think yours is different enough to warrant a new +issue, then that's fine. + +- If this is a bug report, be as specific as possible. + +Something like "It wont work" does not help at all. +Non-Specific bug reports will be closed immediately and marked as invalid. diff --git a/docs/docs/index.md b/docs/docs/index.md index 73eb56a56..634e189ab 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -27,7 +27,7 @@ infrastructure that powers Tachi. This also contains contribution information. -View it [here](./codebase/overview.md). +View it [here](./tachi-server/overview.md). ### User Reference @@ -41,8 +41,10 @@ View it [here](./user/overview.md). If you want to contribute to this documentation, you can find the repository [here!](https://github.com/TeamNewGuys/tachi-docs) If you want to contribute to the Tachi backend code, you can find the repository [here!](https://github.com/TeamNewGuys/tachi-server) + + !!! note - You should really read the [Contributing To Tachi](./codebase/contributing.md) page beforehand! + You should really read the [Contributing To Tachi](./tachi-server/contributing.md) page beforehand! ## Acknowledgements diff --git a/docs/docs/tachi-bot/overview.md b/docs/docs/tachi-bot/overview.md new file mode 100644 index 000000000..30ade9572 --- /dev/null +++ b/docs/docs/tachi-bot/overview.md @@ -0,0 +1,5 @@ +# Bot Overview + +This part of the documentation is for the [Tachi-Bot](https://github.com/TeamNewGuys/tachi-bot). + +At the moment, it's empty. I'll get around to filling it out soon. diff --git a/docs/docs/tachi-server/contributing.md b/docs/docs/tachi-server/contributing.md index f90d19f0a..801c353f1 100644 --- a/docs/docs/tachi-server/contributing.md +++ b/docs/docs/tachi-server/contributing.md @@ -1,4 +1,4 @@ -# Contributing To Tachi +# Contributing To Tachi Server If you want to contribute to Tachi, that's really appreciated! @@ -7,44 +7,6 @@ any help is really appreciated. ***** -## For Newcomers - -If you're looking to contribute to Tachi but aren't -really familiar with TypeScript or other things -we use, Documentation Contributions are highly -appreciated, and accessible to do without any -programming knowledge. - -If you're not familiar with git, I would recommend -downloading [GitHub Desktop](https://desktop.github.com/). - -It has a nice, intuitive UI for making changes, and -saves the trouble of having to explain how forks work. - -## Documentation Contributions - -The documentation for Tachi may have typos, slight mistakes -or inconsistencies. Fixes for those are always appreciated. - -Larger documentation contributions (such as documenting -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/TeamNewGuys/tachi-docs), and -fork the repository. - -## Non-Code Contributions - -Inside the Discord Servers for Bokutachi and Kamaitachi is -a `#help-wanted` channel. This channel lists things that I -currently cannot do, either for time or knowledge reasons. - -These are not code related contributions, and can range from -cool images of cabinets/setups to milestones for a game. - -These are also significantly appreciated. - ## Codebase Contributions `tachi-server` is the core of the logic behind tachi, and @@ -67,65 +29,6 @@ I am trying to keep the codebase well organised and tidy. This only works on git 2.23 or greater. Your package manager may not have a version this recent. See [Git Installation for Linux](https://git-scm.com/download/linux). -### Pull Requests - -You can contribute to `tachi-server` by going to the -[GitHub](https://github.com/TeamNewGuys/tachi-server), forking, -and then making your changes. - -There are a couple of strict guidelines to follow when -writing code contributions (Pull Requests). Not following these may -result in your pull request being rejected. - -- Write tests. - -Your new code should be tested. You can read how and where -tests work in [Testing](./infrastructure/testing). - -- Follow the style guide. - -Your new code should follow the style of the repo. The linter -should not have any errors. Generally, write code that -looks like it belongs. - -- Follow the branching rules. - -Your code should follow the branching setup we have. -You can read about it [here](./infrastructure/branches). - -- Your PR should fix an issue. - -If there isn't an issue for your PR, you should make one -before making the PR. - -For larger PRs, such as making new features/new support, -you should make the issue in advance so discussion can -occur (so you don't waste your time on code that can't -be merged). - -### Issues - -Submitting issues to `tachi-server` is encouraged. Despite -the GitHub name of 'issues', issues may also be feature -requests, new support requests, and similar things. - -Guidelines for submitting issues are as follows: - -- Be Nice. - -Self-explanatory. Remember the human! - -- Make sure your issue isn't already reported as a duplicate. - -This saves me a lot of time. If there's a similar issue -but you think yours is different enough to warrant a new -issue, then that's fine. - -- If this is a bug report, be as specific as possible. - -Something like "It wont work" does not help at all. -Non-Specific bug reports will be closed immediately and marked as invalid. - -- Documentation issues go in the other repo. - -Documentation issues should go [here](https://github.com/TeamNewGuys/tachi-docs) instead. +!!! warn + Your code should follow the branching setup we have. + You can read about it [here](./infrastructure/branches). \ No newline at end of file diff --git a/docs/docs/user/stats/esd.md b/docs/docs/user/stats/esd.md index 06f16a64c..64cd2a701 100644 --- a/docs/docs/user/stats/esd.md +++ b/docs/docs/user/stats/esd.md @@ -45,7 +45,7 @@ to derive other statistics from. and every hit has to involve a timing window. For details on the implementation of ESD, you can see -[here](../../codebase/implementation-details/esd.md). +[here](../../tachi-server/implementation-details/esd.md). !!! warning Implementation details about ESD require some diff --git a/docs/docs/user/stats/tachi.md b/docs/docs/user/stats/tachi.md index 01ce49637..150bdc9d1 100644 --- a/docs/docs/user/stats/tachi.md +++ b/docs/docs/user/stats/tachi.md @@ -5,7 +5,7 @@ statistics used for each game, and what they mean. !!! note These explainations brush over the technical details a bit. If you're interested - in that, you might want to see the [Implementation Details](../../codebase/implementation-details/statistics.md). + in that, you might want to see the [Implementation Details](../../tachi-server/implementation-details/statistics.md). ***** diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index bba9e4e1c..097100d02 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -24,6 +24,7 @@ theme: nav: - Introduction: "index.md" + - Contributing: "contributing.md" - User Reference: - "user/overview.md" @@ -117,6 +118,9 @@ nav: - "tachi-server/documents/score.md" - "tachi-server/documents/goal.md" - "tachi-server/documents/user-goal.md" + + - Tachi Bot Reference: + - "tachi-bot/overview.md" markdown_extensions: - admonition