From ef90ae37d9b173317932e03d9781f468fe5d254b Mon Sep 17 00:00:00 2001 From: Weather Date: Wed, 18 Mar 2026 04:03:48 -0400 Subject: [PATCH 1/2] Core Scripts Documented --- docs/core/CSH Calendar.md | 14 ++++++++++++++ docs/core/Slack.md | 8 ++++++++ docs/core/Wiki-thoughts.md | 14 ++++++++++++++ mkdocs.yml | 6 +++++- 4 files changed, 41 insertions(+), 1 deletion(-) create mode 100644 docs/core/CSH Calendar.md create mode 100644 docs/core/Slack.md create mode 100644 docs/core/Wiki-thoughts.md diff --git a/docs/core/CSH Calendar.md b/docs/core/CSH Calendar.md new file mode 100644 index 0000000..986b1d9 --- /dev/null +++ b/docs/core/CSH Calendar.md @@ -0,0 +1,14 @@ +## Overview + +This core component is used for all the fetching, formatting and structuring for the CSH calendar portion of Jumpstart. + +--- + +### Yielding + +During a fetch of the calendar, if any other clients attempt to connect, they will be yielding async until the initial calendar cache has returned. + +--- + +### Documentation Overview +::: core.cshcalendar \ No newline at end of file diff --git a/docs/core/Slack.md b/docs/core/Slack.md new file mode 100644 index 0000000..f2f2e20 --- /dev/null +++ b/docs/core/Slack.md @@ -0,0 +1,8 @@ +## Overview + +This component handles the Slack Bot and it's related functions. Such as responding to announcments, requesting to upload to Jumpstart, and the other handles with Slack. + +--- + +### Documentation Overview +::: core.slack \ No newline at end of file diff --git a/docs/core/Wiki-thoughts.md b/docs/core/Wiki-thoughts.md new file mode 100644 index 0000000..8842c2f --- /dev/null +++ b/docs/core/Wiki-thoughts.md @@ -0,0 +1,14 @@ +# WARNING + +*"Should be pretty simple, but just in case, you garbage children have to talk to a Wiki Maintainer before adding to this category. Either that, or we'll have a less friendly talk with you instead."* + +As stated from the Wiki Maintainers, do not add any wiki page into the Jumpstart Curated category without prior approval from a Wiki Maintainer. All information being displayed publicly needs to be verified before it is able to be shown. Don't ruin this for the rest of us + +## Overview + +This component handles the fetching, caching and cycling of the CSH Wikithoughts, also known as Jumpstart Curated. This is a list of CSH wiki articles to be displayed on the Jumpstart application. + +--- + +### Documentation Overview +::: core.wikithoughts \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index 7b27659..f903f08 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -39,7 +39,11 @@ nav: - Home: index.md - Getting Started: getting-started/getting-started.md - Endpoints: - - v1: endpoints/endpoints.md + - Endpoints: endpoints/endpoints.md + - Core: + - Calendar: core/CSH Calendar.md + - Slack: core/Slack.md + - Wikithoughts: core/Wiki-thoughts.md - Scripts: - Setup: getting-started/setup.md From dc495ada716182f9fc42482bc85d2315e703db55 Mon Sep 17 00:00:00 2001 From: Weather Date: Wed, 18 Mar 2026 04:31:03 -0400 Subject: [PATCH 2/2] Getting Started Page --- docs/getting-started/getting-started.md | 26 +++++++++++++++ docs/index.md | 44 +++++++++++-------------- mkdocs.yml | 2 -- src/core/wikithoughts.py | 3 ++ 4 files changed, 48 insertions(+), 27 deletions(-) diff --git a/docs/getting-started/getting-started.md b/docs/getting-started/getting-started.md index e69de29..4cd1770 100644 --- a/docs/getting-started/getting-started.md +++ b/docs/getting-started/getting-started.md @@ -0,0 +1,26 @@ + +## Installing +1. Clone and cd into the repo: git clone https://github.com/WeatherGod3218/jumpstartV2 +>> Make another branch if you are working on a large PR +2. + +## Setup +1. Make sure you have docker installed +>> (OPTIONAL): You can use docker compose as well!! +2. Copy the .env.template file, rename it to .env and place it in the root folder +3. Ask an RTP for jumpstart secrets, add them to the .env accordingly + +## Run +1. Build the docker file +``` + docker build -t Jumpstart . +``` +2. Run the newly built docker on port 8000 +``` + docker run -p 8080:80 Jumpstart +``` + +### Alternatively, you can run the docker compose file as well +``` + docker compose up +``` \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 04674b3..c163f3e 100644 --- a/docs/index.md +++ b/docs/index.md @@ -5,34 +5,28 @@ ![Static Badge](https://img.shields.io/badge/%40gravy-made_by?style=flat-square&logo=github&labelColor=%230d1117&color=%23E11C52&link=https%3A%2F%2Fgithub.com%2FNikolaiStrong) -A graphical interface that displays information in the elevator lobby of Computer Science House. +A graphical interface that displays information in the elevator lobby of Computer Science House. All information displayed has been authorized to been shown. This project uses Python, [FastAPI](https://fastapi.tiangolo.com/), HTML/CSS, and Javascript. See it live [here](http://jumpstart-squared.cs.house/)! -## Installing -1. Clone and cd into the repo: git clone https://github.com/WeatherGod3218/jumpstartV2 ->> (OPTIONAL): Make another branch if your working on a large thing! - -## Setup -1. Make sure you have docker installed ->> (OPTIONAL): You can use docker compose as well!! -2. Copy the .env.template file, rename it to .env and place it in the root folder -3. Ask an RTP for jumpstart secrets, add them to the .env accordingly - -## Run -1. Build the docker file -``` - docker build -t Jumpstart . -``` -2. Run the newly built docker on port 8000 -``` - docker run -p 8080:80 Jumpstart -``` - -## Alternatively, you can run the docker compose file as well -``` - docker compose up -``` +The application has multiple features: + 1. Displays the date & time + 2. CSH Logo that changes colors based on time of day. The logo can also change for holidays + + 3. A spot for announcements, which E-Board members can make through our Slack. This is done using a custom Slack app that utilizes Slack’s APIs. + + 4. A section that displays a random title from r/showerthoughts every 30 seconds. + + 5. An informational that displays real-time status information from CSH’s server room. + + 6. Calendar module that uses the Python ICalendar to display a countdown to the next 10 events from the CSH calendar. + + 7. Displays a daily forecast. + +### AUTHORS: +- Eli Mares +- Stella Hellinger +- Nikolai Strong diff --git a/mkdocs.yml b/mkdocs.yml index f903f08..2ccec6d 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -44,8 +44,6 @@ nav: - Calendar: core/CSH Calendar.md - Slack: core/Slack.md - Wikithoughts: core/Wiki-thoughts.md - - Scripts: - - Setup: getting-started/setup.md plugins: - search diff --git a/src/core/wikithoughts.py b/src/core/wikithoughts.py index 56f3f58..15e257d 100644 --- a/src/core/wikithoughts.py +++ b/src/core/wikithoughts.py @@ -57,6 +57,9 @@ def clean_wikitext(text: str) -> str: # [[Page]] -> Page text = re.sub(r"\[\[([^\]]+)\]\]", r"\1", text) + # ^^CSH Account^^ -> User CSH Account + text = re.sub(r"\^\^([^\]]+)\^\^", r"User \1", text) + # Remove templates {{...}} text = re.sub(r"\{\{.*?\}\}", "", text, flags=re.DOTALL)