From fead2d2fe99327a4bdeb0416b68503489ad6ffd7 Mon Sep 17 00:00:00 2001 From: zkldi <20380519+zkldi@users.noreply.github.com> Date: Sun, 14 Aug 2022 17:49:33 +0100 Subject: [PATCH] feat: move tachi-server/documents to schemas --- .../documents => schemas}/chart.md | 0 .../documents => schemas}/goal-sub.md | 0 .../documents => schemas}/goal.md | 0 docs/docs/schemas/index.md | 7 +++++++ .../documents => schemas}/overview.md | 0 .../documents => schemas}/score.md | 0 .../documents => schemas}/session.md | 0 .../documents => schemas}/song.md | 0 .../documents => schemas}/user.md | 0 docs/mkdocs.yml | 20 +++++++++---------- 10 files changed, 17 insertions(+), 10 deletions(-) rename docs/docs/{tachi-server/documents => schemas}/chart.md (100%) rename docs/docs/{tachi-server/documents => schemas}/goal-sub.md (100%) rename docs/docs/{tachi-server/documents => schemas}/goal.md (100%) create mode 100644 docs/docs/schemas/index.md rename docs/docs/{tachi-server/documents => schemas}/overview.md (100%) rename docs/docs/{tachi-server/documents => schemas}/score.md (100%) rename docs/docs/{tachi-server/documents => schemas}/session.md (100%) rename docs/docs/{tachi-server/documents => schemas}/song.md (100%) rename docs/docs/{tachi-server/documents => schemas}/user.md (100%) diff --git a/docs/docs/tachi-server/documents/chart.md b/docs/docs/schemas/chart.md similarity index 100% rename from docs/docs/tachi-server/documents/chart.md rename to docs/docs/schemas/chart.md diff --git a/docs/docs/tachi-server/documents/goal-sub.md b/docs/docs/schemas/goal-sub.md similarity index 100% rename from docs/docs/tachi-server/documents/goal-sub.md rename to docs/docs/schemas/goal-sub.md diff --git a/docs/docs/tachi-server/documents/goal.md b/docs/docs/schemas/goal.md similarity index 100% rename from docs/docs/tachi-server/documents/goal.md rename to docs/docs/schemas/goal.md diff --git a/docs/docs/schemas/index.md b/docs/docs/schemas/index.md new file mode 100644 index 000000000..759cf8cf8 --- /dev/null +++ b/docs/docs/schemas/index.md @@ -0,0 +1,7 @@ +# Documents + +This section of the docs covers the various documents used in Tachi, such as song documents and score documents. + +!!! help + This page isn't entirely finalised. You might have to check the [Tachi Common Source Code](https://github.com/TNG-dev/Tachi/tree/develop/common) for certain documents. + diff --git a/docs/docs/tachi-server/documents/overview.md b/docs/docs/schemas/overview.md similarity index 100% rename from docs/docs/tachi-server/documents/overview.md rename to docs/docs/schemas/overview.md diff --git a/docs/docs/tachi-server/documents/score.md b/docs/docs/schemas/score.md similarity index 100% rename from docs/docs/tachi-server/documents/score.md rename to docs/docs/schemas/score.md diff --git a/docs/docs/tachi-server/documents/session.md b/docs/docs/schemas/session.md similarity index 100% rename from docs/docs/tachi-server/documents/session.md rename to docs/docs/schemas/session.md diff --git a/docs/docs/tachi-server/documents/song.md b/docs/docs/schemas/song.md similarity index 100% rename from docs/docs/tachi-server/documents/song.md rename to docs/docs/schemas/song.md diff --git a/docs/docs/tachi-server/documents/user.md b/docs/docs/schemas/user.md similarity index 100% rename from docs/docs/tachi-server/documents/user.md rename to docs/docs/schemas/user.md diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml index 6d30b3dc9..c5689bd25 100644 --- a/docs/mkdocs.yml +++ b/docs/mkdocs.yml @@ -52,6 +52,16 @@ nav: - "user/stats/tachi.md" # - "user/stats/esd.md" + - Documents: + - "schemas/overview.md" + - "schemas/user.md" + - "schemas/session.md" + - "schemas/score.md" + - "schemas/song.md" + - "schemas/chart.md" + - "schemas/goal.md" + - "schemas/goal-sub.md" + - API Reference: - "api/overview.md" - "api/auth.md" @@ -138,16 +148,6 @@ nav: - "tachi-server/implementation-details/goal-id.md" - "tachi-server/implementation-details/goals-milestones.md" - - Documents: - - "tachi-server/documents/overview.md" - - "tachi-server/documents/user.md" - - "tachi-server/documents/session.md" - - "tachi-server/documents/score.md" - - "tachi-server/documents/song.md" - - "tachi-server/documents/chart.md" - - "tachi-server/documents/goal.md" - - "tachi-server/documents/goal-sub.md" - - Tachi Bot Reference: - "tachi-bot/overview.md"