From 93b2a763248b6d129dc1dddcbf2162e2527d5815 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 12:18:34 +0000 Subject: [PATCH 01/16] Update project info --- docs/source/conf.py | 32 ++++++++++++++++---------------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6e9e8c087..f21c7a6e6 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -2,34 +2,34 @@ # -- Project information -project = 'Lumache' -copyright = '2021, Graziella' -author = 'Graziella' +project = "Group Coursework Management System (GCMS)" +copyright = "2026, Group 5B" +author = "Group 5B" -release = '0.1' -version = '0.1.0' +release = "0.1" +version = "0.1.0" # -- General configuration extensions = [ - 'sphinx.ext.duration', - 'sphinx.ext.doctest', - 'sphinx.ext.autodoc', - 'sphinx.ext.autosummary', - 'sphinx.ext.intersphinx', + "sphinx.ext.duration", + "sphinx.ext.doctest", + "sphinx.ext.autodoc", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", ] intersphinx_mapping = { - 'python': ('https://docs.python.org/3/', None), - 'sphinx': ('https://www.sphinx-doc.org/en/master/', None), + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), } -intersphinx_disabled_domains = ['std'] +intersphinx_disabled_domains = ["std"] -templates_path = ['_templates'] +templates_path = ["_templates"] # -- Options for HTML output -html_theme = 'sphinx_rtd_theme' +html_theme = "sphinx_rtd_theme" # -- Options for EPUB output -epub_show_urls = 'footnote' +epub_show_urls = "footnote" From 74bdbd19215c4ec4c8aa77704509315703da7adc Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 12:21:40 +0000 Subject: [PATCH 02/16] Update project settings --- docs/source/index.rst | 7 ++----- pyproject.toml | 4 ++-- 2 files changed, 4 insertions(+), 7 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 03d09a55d..03f6d2539 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,10 +1,7 @@ -Welcome to Lumache's documentation! +Welcome to Group Coursework Management System (GCMS)'s documentation! =================================== -**Lumache** (/lu'make/) is a Python library for cooks and food lovers -that creates recipes mixing random ingredients. -It pulls data from the `Open Food Facts database `_ -and offers a *simple* and *intuitive* API. +**GCMS** is a web application to help students manage their group coursework projects. Check out the :doc:`usage` section for further information, including how to :ref:`installation` the project. diff --git a/pyproject.toml b/pyproject.toml index 14a2dda5d..f6a2e24b8 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -3,6 +3,6 @@ requires = ["flit_core >=3.2,<4"] build-backend = "flit_core.buildapi" [project] -name = "lumache" -authors = [{name = "Graziella", email = "graziella@lumache"}] +name = "gcms" +authors = [{name = "Group 5B", email = ""}] dynamic = ["version", "description"] From f82be8e11df800ded3f095f475f0b17f36b5fdde Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 12:41:50 +0000 Subject: [PATCH 03/16] Update README.md file --- README.rst | 8 ++------ 1 file changed, 2 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index 07eac7fd1..9ab15cba2 100644 --- a/README.rst +++ b/README.rst @@ -1,9 +1,5 @@ -Template for the Read the Docs tutorial +'Read The Docs' Documentation for Group Course Management System (GCMS) ======================================= -This GitHub template includes fictional Python library -with some basic Sphinx docs. - -Read the tutorial here: - +'Read The Docs' tutorial here: https://docs.readthedocs.io/en/stable/tutorial/ From 2f68b9a169315d2dc11b3e08a0f2f26c0531751d Mon Sep 17 00:00:00 2001 From: Jaketh444 Date: Wed, 25 Feb 2026 13:17:54 +0000 Subject: [PATCH 04/16] Basic Structure Setup --- docs/source/architecture.rst | 7 +++++++ docs/source/index.rst | 4 ++++ docs/source/installation.rst | 9 +++++++++ docs/source/usage.rst | 15 +++++++++++++++ 4 files changed, 35 insertions(+) create mode 100644 docs/source/architecture.rst create mode 100644 docs/source/installation.rst diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst new file mode 100644 index 000000000..df3ffec9e --- /dev/null +++ b/docs/source/architecture.rst @@ -0,0 +1,7 @@ +1 page, diagrams optional: + +frontend vs backend + +“layered event-driven architecture with centralized event bus” (from your README) + +key external APIs (Microsoft Graph, OpenAI) \ No newline at end of file diff --git a/docs/source/index.rst b/docs/source/index.rst index 03f6d2539..aa75345d2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -15,5 +15,9 @@ Contents .. toctree:: + installation usage + architecture api + contributing + changelog diff --git a/docs/source/installation.rst b/docs/source/installation.rst new file mode 100644 index 000000000..403af9a9b --- /dev/null +++ b/docs/source/installation.rst @@ -0,0 +1,9 @@ +Pull directly from your main repo reality: + +prerequisites (Node version, npm) + +how to run (npm install, npm start / whatever you use) + +environment variables (.env example) + +database setup (you have a db/ folder) \ No newline at end of file diff --git a/docs/source/usage.rst b/docs/source/usage.rst index 924afcf6c..20cd06ddf 100644 --- a/docs/source/usage.rst +++ b/docs/source/usage.rst @@ -31,4 +31,19 @@ For example: >>> import lumache >>> lumache.get_random_ingredients() ['shells', 'gorgonzola', 'parsley'] +----------------------------------------------------- +Document the core features from your README: +Microsoft sign-in / OneDrive integration + +tasks + weighting + +calendar + +chat + +project board + +notifications + +contribution tracking \ No newline at end of file From d3cf599ff585b5e54f0d8d7316c858c1e21cdc6e Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:47:07 +0000 Subject: [PATCH 05/16] Test --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index aa75345d2..91414599e 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,7 +4,7 @@ Welcome to Group Coursework Management System (GCMS)'s documentation! **GCMS** is a web application to help students manage their group coursework projects. Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. +how to :ref:`installation` the project. :ref:`architecture` .. note:: From df03d900cd2a0844371e8c01f6823f7d3115c2a8 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:48:20 +0000 Subject: [PATCH 06/16] Test --- docs/source/architecture.rst | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index df3ffec9e..cd06d57bb 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -1,7 +1,13 @@ +API +=== + 1 page, diagrams optional: frontend vs backend “layered event-driven architecture with centralized event bus” (from your README) -key external APIs (Microsoft Graph, OpenAI) \ No newline at end of file +key external APIs (Microsoft Graph, OpenAI) + +.. autosummary:: + :toctree: generated From 371618cfe3445f470550ae4544a01ed8e81926cb Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:49:22 +0000 Subject: [PATCH 07/16] Test --- docs/source/architecture.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index cd06d57bb..480f42477 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -1,5 +1,5 @@ -API -=== +Architecture +============ 1 page, diagrams optional: From 2308b121c21db03fde2c794dad4166cb65c7ac77 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:51:31 +0000 Subject: [PATCH 08/16] Test ;) --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 91414599e..a1ab2dc64 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,7 +4,7 @@ Welcome to Group Coursework Management System (GCMS)'s documentation! **GCMS** is a web application to help students manage their group coursework projects. Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. :ref:`architecture` +how to :ref:`installation` the project. :doc:`architecture` :ref:`contents` .. note:: From 6570503c0442f8febcc3072742ed1bb6e82f0cc8 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:52:56 +0000 Subject: [PATCH 09/16] another test --- docs/source/architecture.rst | 5 +++-- docs/source/index.rst | 2 +- 2 files changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index 480f42477..e9b0a1823 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -9,5 +9,6 @@ frontend vs backend key external APIs (Microsoft Graph, OpenAI) -.. autosummary:: - :toctree: generated +Text +---- +This is a new section diff --git a/docs/source/index.rst b/docs/source/index.rst index a1ab2dc64..cd6ae62fa 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,7 +4,7 @@ Welcome to Group Coursework Management System (GCMS)'s documentation! **GCMS** is a web application to help students manage their group coursework projects. Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. :doc:`architecture` :ref:`contents` +how to :ref:`installation` the project. :doc:`architecture` :ref:`text` .. note:: From 25f3129f42f3802612bfa679f789988d3ec61e16 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:54:46 +0000 Subject: [PATCH 10/16] more tests --- docs/source/architecture.rst | 6 +----- docs/source/index.rst | 2 +- 2 files changed, 2 insertions(+), 6 deletions(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index e9b0a1823..ba5ae152a 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -1,6 +1,6 @@ Architecture ============ - +.._arch-sec: 1 page, diagrams optional: frontend vs backend @@ -8,7 +8,3 @@ frontend vs backend “layered event-driven architecture with centralized event bus” (from your README) key external APIs (Microsoft Graph, OpenAI) - -Text ----- -This is a new section diff --git a/docs/source/index.rst b/docs/source/index.rst index cd6ae62fa..b821f124a 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -4,7 +4,7 @@ Welcome to Group Coursework Management System (GCMS)'s documentation! **GCMS** is a web application to help students manage their group coursework projects. Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. :doc:`architecture` :ref:`text` +how to :ref:`installation` the project. :doc:`architecture` :ref:`arch-sec` .. note:: From 11ee1adb6e0c234f85f8e05e340007bdfb50f7e8 Mon Sep 17 00:00:00 2001 From: Harry Date: Wed, 25 Feb 2026 13:56:40 +0000 Subject: [PATCH 11/16] add space --- docs/source/architecture.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index ba5ae152a..9a9cc670a 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -1,6 +1,6 @@ Architecture ============ -.._arch-sec: +.. _arch-sec: 1 page, diagrams optional: frontend vs backend From defb5d8ba629150d2f136acfcc6a4ccdff637657 Mon Sep 17 00:00:00 2001 From: Jay McKerracher Date: Wed, 25 Feb 2026 14:10:04 +0000 Subject: [PATCH 12/16] add ref to architecture section --- docs/source/architecture.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/architecture.rst b/docs/source/architecture.rst index 9a9cc670a..3130dbe54 100644 --- a/docs/source/architecture.rst +++ b/docs/source/architecture.rst @@ -1,6 +1,6 @@ +.. _arch-sec: Architecture ============ -.. _arch-sec: 1 page, diagrams optional: frontend vs backend From 3d04c4736eb6bbabb38d98670a4dc3c896b33b1a Mon Sep 17 00:00:00 2001 From: Jaketh444 Date: Wed, 22 Apr 2026 13:18:05 +0100 Subject: [PATCH 13/16] restructure documentation layout and improve table of contents Co-authored-by: Copilot --- docs/source/index.rst | 87 ++++++++++++++++++++++++++++++++++++------- 1 file changed, 73 insertions(+), 14 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index b821f124a..d9562003d 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,23 +1,82 @@ -Welcome to Group Coursework Management System (GCMS)'s documentation! -=================================== +Group Coursework Management System (GCMS) Documentation +====================================================== **GCMS** is a web application to help students manage their group coursework projects. -Check out the :doc:`usage` section for further information, including -how to :ref:`installation` the project. :doc:`architecture` :ref:`arch-sec` - .. note:: - This project is under active development. -Contents --------- - .. toctree:: + :maxdepth: 2 + :caption: Table of Contents - installation - usage - architecture - api + getting-started/index + architecture/index + database-schema/index + api-reference/index + external-integrations/index + troubleshooting contributing - changelog + +Getting Started +--------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + getting-started/prerequisites + getting-started/installation + getting-started/environment-configuration + getting-started/database-setup + getting-started/running-the-app + +Architecture +--------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + architecture/overview + architecture/folder-structure + architecture/event-bus + +Database Schema +-------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + database-schema/entity-reference + database-schema/er-diagram + +API Reference +---------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + api-reference/auth-routes + api-reference/project-routes + api-reference/task-routes + api-reference/other-routes + +External Integrations +--------------------------------------------------- + +.. toctree:: + :maxdepth: 1 + :hidden: + + external-integrations/microsoft-graph + external-integrations/openai + external-integrations/emailjs + +Troubleshooting +------------------------------- + +Contributing +-------------------------- From 2dfa45d0dc50861b738fc08420eaa0532dbde373 Mon Sep 17 00:00:00 2001 From: Jaketh444 Date: Wed, 22 Apr 2026 14:50:39 +0100 Subject: [PATCH 14/16] fix: adjust header underline length in documentation --- docs/source/index.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d9562003d..e3c4af180 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,5 +1,5 @@ Group Coursework Management System (GCMS) Documentation -====================================================== +======================================================== **GCMS** is a web application to help students manage their group coursework projects. From 10d79cccb42576bcc132c721c219df78cb2da133 Mon Sep 17 00:00:00 2001 From: Jaketh444 Date: Wed, 22 Apr 2026 14:52:22 +0100 Subject: [PATCH 15/16] refactor: update Getting Started section formatting in documentation --- docs/source/index.rst | 15 +++++++-------- 1 file changed, 7 insertions(+), 8 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e3c4af180..d017a9929 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -18,18 +18,17 @@ Group Coursework Management System (GCMS) Documentation troubleshooting contributing -Getting Started ---------------------------------------- +Getting Started +=============== .. toctree:: :maxdepth: 1 - :hidden: - getting-started/prerequisites - getting-started/installation - getting-started/environment-configuration - getting-started/database-setup - getting-started/running-the-app + prerequisites + installation + environment-configuration + database-setup + running-the-app Architecture --------------------------------- From 5bddea7e0a321f3532ee7d44d5a80859ad6cac07 Mon Sep 17 00:00:00 2001 From: Jaketh444 Date: Wed, 22 Apr 2026 15:00:26 +0100 Subject: [PATCH 16/16] remove Getting Started and Architecture sections from documentation index Co-authored-by: Copilot --- docs/source/index.rst | 21 --------------------- 1 file changed, 21 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index d017a9929..307b2bb47 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -17,27 +17,6 @@ Group Coursework Management System (GCMS) Documentation external-integrations/index troubleshooting contributing - -Getting Started -=============== - -.. toctree:: - :maxdepth: 1 - - prerequisites - installation - environment-configuration - database-setup - running-the-app - -Architecture ---------------------------------- - -.. toctree:: - :maxdepth: 1 - :hidden: - - architecture/overview architecture/folder-structure architecture/event-bus