From 73607d64f606ea2bebb9dba08b407b2b441c3572 Mon Sep 17 00:00:00 2001 From: Upstream Data Date: Tue, 27 Aug 2024 15:01:02 -0600 Subject: [PATCH] Update the docs to match the new project format. --- docs/index.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/docs/index.md b/docs/index.md index 48307461..dcee3367 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,6 +1,6 @@ # gooseBit - + --- @@ -117,11 +117,10 @@ The structure of gooseBit is as follows: - `updater`: DDI API handler and device update manager. - `updates`: SWUpdate file parsing. - `realtime`: Realtime API functionality with websockets. -- `auth`: Authentication functions. +- `auth`: Authentication functions, including permissions. - `models`: Database models. - `db`: Database config and initialization. - `schema`: Pydantic models used for API type hinting. -- `permissions`: Permission handling and permission enums. - `settings`: Settings loader and handler. - `telemetry`: Telemetry data handlers. -- `routes`: Routes for a giving endpoint, including the router. +- `routes`: Routes for a given endpoint, including the router.