feat: repoint overview.md to index.md

This commit is contained in:
zkldi
2022-08-16 23:12:27 +01:00
parent 8d0948181b
commit 8f458047fa
4 changed files with 16 additions and 16 deletions
+7 -7
View File
@@ -16,7 +16,7 @@ both [Bokutachi](https://bokutachi.xyz) and [Kamaitachi](https://kamaitachi.xyz)
Because Tachi is fully open source, if you want a feature, bug-fix, or new content added to your game,
you can *become a contributor* or *report to someone who will contribute!*
We maintain a **comprehensive** [contribution guide](./contributing/overview.md), which is accessible
We maintain a **comprehensive** [contribution guide](./contributing), which is accessible
to even people who have never wrote a line of code in their life. If you want to improve Tachi, and maybe even
nab some development skills yourself (or look good on a CV!), check it out. I've put a lot of effort into it.
@@ -30,7 +30,7 @@ person, and as such, some things may be slightly outdated, wrong, or generally j
We have a remarkably helpful community of developers and contributors, who should be able to help you out.
Apologies in advance! If you find a problem in the documentation, you can freely contribute a fix
to it. See the [Contribution Guide](./contributing/overview.md)!
to it. See the [Contribution Guide](./contributing)!
*****
@@ -39,14 +39,14 @@ to it. See the [Contribution Guide](./contributing/overview.md)!
These sections are for experienced programmers who want to see documentation on how
Tachi's components work internally and externally.
If you're looking to contribute to Tachi, check out the [Contribution Guide](./contributing/overview.md).
If you're looking to contribute to Tachi, check out the [Contribution Guide](./contributing).
### API Reference
This is for people who want to make things with Tachi's API, and assumes basic knowledge of
APIs and how they work.
View it [here](./api/overview.md).
View it [here](./api).
### Server Codebase Reference
@@ -54,20 +54,20 @@ This is for people who want to work on `Tachi-Server`'s codebase.
This contains things like the tools we use and the
infrastructure that powers Tachi.
View it [here](./tachi-server/overview.md).
View it [here](./tachi-server).
### Bot Codebase Reference
This is for people who want to work on the `Tachi-Bot`.
View it [here](./tachi-bot/overview.md).
View it [here](./tachi-bot).
### Wiki
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/overview.md).
View it [here](./user).
## Acknowledgements
+1 -1
View File
@@ -55,7 +55,7 @@ The base score document is structured as follows:
| Property | Description |
| :: | :: |
| `game` | This is the game this score is for. |
| `service` | This is a humanised string for representing the place this score came from. This is primarily used by [Batch-Manual](../tachi-server/batch-manual/overview.md) formats to declare where the scores are coming from. |
| `service` | This is a humanised string for representing the place this score came from. This is primarily used by [Batch-Manual](../tachi-server/batch-manual) formats to declare where the scores are coming from. |
| `userID` | The user that got this score. |
| `timeAchieved` | This is the time this score was actually achieved. This is **NOT** the time this score was inserted into the database. If this is not known, it can be set to null. |
| `timeAdded` | This is the time the score was added to the Tachi database. This is **NOT** the time the score was achieved by the player. |
@@ -15,7 +15,7 @@ lamps for the game.
It would be really appreciated if someone formatted
the configurations for every game! For the time being,
the below documentation is just the raw configuration
for each game. Please see [Contributing to Tachi](../../contributing/overview.md).
for each game. Please see [Contributing to Tachi](../../contributing).
*****
+7 -7
View File
@@ -26,7 +26,7 @@ nav:
- Getting Started:
- "index.md"
- Contributing:
- "contributing/overview.md"
- "contributing"
- "contributing/setup.md"
- "contributing/components.md"
- Component-Specific Guides:
@@ -39,7 +39,7 @@ nav:
- "contributing/tools/vscode.md"
- Wiki:
- "user/overview.md"
- "user/index.md"
- "user/rules.md"
- "user/games.md"
- "user/features.md"
@@ -63,7 +63,7 @@ nav:
- "schemas/goal-sub.md"
- API Reference:
- "api/overview.md"
- "api/index.md"
- "api/auth.md"
- "api/terminology.md"
@@ -95,7 +95,7 @@ nav:
- "api/webhooks/class-update-v1.md"
- Tachi Server Reference:
- "tachi-server/overview.md"
- "tachi-server/index.md"
- Setup:
- "tachi-server/setup/config.md"
@@ -116,11 +116,11 @@ nav:
- "tachi-server/structure/testing.md"
- BATCH-MANUAL:
- "tachi-server/batch-manual/overview.md"
- "tachi-server/batch-manual"
- "tachi-server/batch-manual/direct-manual.md"
- Score Importing:
- "tachi-server/import/overview.md"
- "tachi-server/import"
- "tachi-server/import/main.md"
- "tachi-server/import/import-types.md"
- "tachi-server/import/parse-conv.md"
@@ -147,7 +147,7 @@ nav:
- "tachi-server/implementation-details/goals-milestones.md"
- Tachi Bot Reference:
- "tachi-bot/overview.md"
- "tachi-bot"
markdown_extensions:
- admonition