Re-organize files

polyphony-chat · Dec 27, 2023 · 1fff76b · 1fff76b
1 parent 7b55a55
commit 1fff76b
Show file tree

Hide file tree

Showing 11 changed files with 34 additions and 14 deletions.
diff --git a/.vscode/ltex.hiddenFalsePositives.en-US.txt b/.vscode/ltex.hiddenFalsePositives.en-US.txt
@@ -8,3 +8,4 @@
 {"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qv0.0.0 - Treat this as an unfinished draft.\\E$"}
 {"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qpolyproto-core Specification\\E$"}
 {"rule":"UPPERCASE_SENTENCE_START","sentence":"^\\Qpolyproto-core Specification\n1.\\E$"}
+{"rule":"ENGLISH_WORD_REPEAT_RULE","sentence":"^\\QGET Get token generation status :material-pail-outline: :material-lock-open-outline:\\E$"}
diff --git a/...Is/Server-Client API/routes/federation.md → ...re/Server-Client API/Routes/federation.md b/...Is/Server-Client API/routes/federation.md → ...re/Server-Client API/Routes/federation.md
@@ -6,7 +6,7 @@ Routes concerning the creation, deletion and management of federation tokens.
 
 ---
 
-### <p class="request-h"><span class="request request-get">GET</span> Generate Federation Token [:material-pail-outline:](../../rate-limits.md "Bucket: federation-token-generation") [:material-lock-outline:](#authorization "Authorization required") </p> 
+### <p class="request-h"><span class="request request-get">GET</span> Generate Federation Token [:material-pail-outline:](../rate-limits.md "Bucket: federation-token-generation") [:material-lock-outline:](#authorization "Authorization required") </p> 
 
 `http://localhost:3001/api/federation/token`
 
@@ -45,7 +45,7 @@ Federation tokens are signed using the home server's public signing key, so that
 
 ---
 
-### <p class="request-h"><span class="request request-get">GET</span> Get token generation status [:material-pail-outline:](../../rate-limits.md "Bucket: ip") [:material-lock-open-outline:](#authorization "Authorization not required")</p>
+### <p class="request-h"><span class="request request-get">GET</span> Get token generation status [:material-pail-outline:](../rate-limits.md "Bucket: ip") [:material-lock-open-outline:](#authorization "Authorization not required")</p>
 
 `http://localhost:3001/api/federation/generation`
 

diff --git a/docs/APIs/errors.md → docs/APIs/Core/Server-Client API/errors.md b/docs/APIs/errors.md → docs/APIs/Core/Server-Client API/errors.md
diff --git a/docs/APIs/Core/Server-Client API/index.md b/docs/APIs/Core/Server-Client API/index.md
@@ -0,0 +1,12 @@
+# Server-Client API
+
+The following pages document the server-client API of polyproto-core. Each file represents a group 
+of routes, organizing them by their purpose.
+
+---
+
+--8<-- "snippets/api.md"
+
+---
+
+--8<-- "snippets/glossary.md"
diff --git a/docs/APIs/rate-limits.md → ...PIs/Core/Server-Client API/rate-limits.md b/docs/APIs/rate-limits.md → ...PIs/Core/Server-Client API/rate-limits.md
diff --git a/docs/APIs/Core/Server-Server API/errors.md b/docs/APIs/Core/Server-Server API/errors.md
@@ -0,0 +1 @@
+# Errors
diff --git a/docs/APIs/Core/Server-Server API/index.md b/docs/APIs/Core/Server-Server API/index.md
@@ -0,0 +1,12 @@
+# Server-Server API
+
+The following pages document the server-server API of polyproto-core. Each file represents a group
+of routes, organizing them by their purpose.
+
+---
+
+--8<-- "snippets/api.md"
+
+---
+
+--8<-- "snippets/glossary.md"
diff --git a/docs/APIs/Core/Server-Server API/rate-limits.md b/docs/APIs/Core/Server-Server API/rate-limits.md
@@ -0,0 +1 @@
+# Rate limits
diff --git a/docs/APIs/Core/index.md b/docs/APIs/Core/index.md
@@ -0,0 +1,5 @@
+---
+title: polyproto-core
+---
+
+This folder contains the API documentation for polyproto-core.
diff --git a/docs/APIs/Server-Client API/index.md b/docs/APIs/Server-Client API/index.md
diff --git a/docs/APIs/Server-Server API/index.md b/docs/APIs/Server-Server API/index.md