From 423aaa6b84df0f16019f9f00866d56f2d252b964 Mon Sep 17 00:00:00 2001 From: StroepWafel <109832156+StroepWafel@users.noreply.github.com> Date: Tue, 7 Apr 2026 19:41:45 +0930 Subject: [PATCH 1/4] Update README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 2726211f..2be4074f 100644 --- a/README.md +++ b/README.md @@ -50,7 +50,7 @@ ## Creating Custom Themes -If you are looking to create custom themes, I would recommend you start at the official documentation [here](https://betterseqta.gitbook.io/betterseqta-docs). You can see some premade examples along with a compilation script that can be used to allow for CSS frameworks and libraries such as SCSS to be used [here](https://github.com/BetterSEQTA/BetterSEQTA-Theme-Generator). +If you are looking to create custom themes, I would recommend you start at the official documentation [here](https://docs.betterseqta.org/). You can see some premade examples along with a compilation script that can be used to allow for CSS frameworks and libraries such as SCSS to be used [here](https://github.com/BetterSEQTA/BetterSEQTA-Theme-Generator). Don't worry- if you get stuck feel free to ask around in the [discord](https://discord.gg/YzmbnCDkat). We're open and happy to help out! Happy creating :) @@ -88,7 +88,7 @@ npm run dev > [!WARNING] > Whenever you update the extension while not in dev mode, you will need to use the reload button on the extension page. -📚 **Need more details?** Check our [detailed setup guide](./docs/GETTING_STARTED_CONTRIBUTING.md#your-first-30-minutes) +📚 **Need more details?** Check our [detailed setup guide](https://docs.betterseqta.org/install/#for-developers-development-environment) ### Building for Production @@ -115,7 +115,7 @@ The folder structure is as follows: -Want to contribute? [Click Here!](https://github.com/BetterSEQTA/BetterSEQTA-Plus/blob/main/CONTRIBUTING.md) +Want to contribute? [Click Here!](https://docs.betterseqta.org/contributing/) ## Credits From aad5bcd97e5e3de8bb40f4d990247de77a0fc3d6 Mon Sep 17 00:00:00 2001 From: StroepWafel <109832156+StroepWafel@users.noreply.github.com> Date: Tue, 7 Apr 2026 19:50:24 +0930 Subject: [PATCH 2/4] Update README.md --- README.md | 103 +++++++++++++++++------------------------------------- 1 file changed, 33 insertions(+), 70 deletions(-) diff --git a/README.md b/README.md index 2be4074f..9a15d00b 100644 --- a/README.md +++ b/README.md @@ -16,37 +16,28 @@ -## Table of contents +## 📚 Documentation +All documentation has been moved to the [official docs site](https://docs.betterseqta.org): -- [Features](#features) -- [Creating Custom Themes](#creating-custom-themes) -- [Getting Started](#getting-started) - - [Running Development](#running-development) - - [Building for production](#building-for-production) - - [Folder Structure](#folder-structure) -- [Contributors](#contributors) -- [Credits](#credits) -- [Star History](#star-history) +Includes: +- Getting started +- Development setup +- Architecture +- Plugin system +- Theme creation ## Features -- Dark mode - - Custom Background/Themes -- Improved Styling/CSS - - Improved look for SEQTA Learn -- Custom Home Page including: - - Daily Lessons - - Shortcuts - - Easier Access Notices - - Assessments -- Options to remove certain items from the side menu +- Dark mode + custom themes +- Improved UI / styling +- Custom home page (lessons, notices, assessments, shortcuts) +- Sidebar customisation - Grades calculator -- Fully customisable themes and an official theme store -- Notification for next lesson (sent 5 minutes before end of the lesson) -- Browser Support - - Chrome, Edge, Brave, Opera and other Chromium-Based browsers are supported - - Firefox Supported: [here](https://addons.mozilla.org/en-US/firefox/addon/betterseqta-plus/)! - - Safari (Experimental and not recommended - only available via compilation) +- Theme system + theme store +- Lesson notifications +- Cross-browser support (Chromium + Firefox) +- Custom themes! + ## Creating Custom Themes @@ -54,60 +45,29 @@ If you are looking to create custom themes, I would recommend you start at the o Don't worry- if you get stuck feel free to ask around in the [discord](https://discord.gg/YzmbnCDkat). We're open and happy to help out! Happy creating :) -## 🚀 Want to Contribute? +## 🚀 Contributing +**New contributors welcome!** +- 📖 Start here: https://betterseqta.github.io/BetterSEQTA-Docs/getting-started/ +- 🧠 Architecture: https://betterseqta.github.io/BetterSEQTA-Docs/architecture/ +- 🧩 Plugins: https://betterseqta.github.io/BetterSEQTA-Docs/plugins/ +- 🐛 Issues: https://github.com/BetterSEQTA/BetterSEQTA-plus/issues +- 💬 Discord: https://discord.gg/YzmbnCDkat -**New contributors welcome!** 🎉 We've made it easy to get started: -- **👋 New to the project?** Start with our [Getting Started Guide](./docs/GETTING_STARTED_CONTRIBUTING.md) -- **🏗️ Want to understand the code?** Check out our [Architecture Guide](./docs/ARCHITECTURE.md) -- **🧩 Interested in plugins?** Read our [Plugin Development Guide](./docs/plugins/README.md) -- **🐛 Found a bug?** Open an [issue](https://github.com/BetterSEQTA/BetterSEQTA-plus/issues) or fix it yourself! -- **💬 Need help?** Join our [Discord community](https://discord.gg/YzmbnCDkat) +## ⚡ Quick Start -We have lots of https://github.com/BetterSEQTA/BetterSEQTA-Plus/labels/good%20first%20issue labels perfect for beginners! - -## Quick Development Setup - -    **1. Fork & Clone** ```bash -git clone https://github.com/YOUR_USERNAME/BetterSEQTA-Plus +git clone https://github.com/YOUR_USERNAME_FORKED_WITH/BetterSEQTA-Plus cd BetterSEQTA-Plus -``` - -    **2. Install & Run** -```bash npm install --legacy-peer-deps npm run dev -``` +```` -    **3. Load in Browser** -1. Go to `chrome://extensions` -2. Enable "Developer mode" -3. Click "Load unpacked" → Select `dist` folder -4. Visit a SEQTA page to see it work! 🎉 -> [!WARNING] -> Whenever you update the extension while not in dev mode, you will need to use the reload button on the extension page. +Then load `dist` in `chrome://extensions` (Developer Mode → Load unpacked). -📚 **Need more details?** Check our [detailed setup guide](https://docs.betterseqta.org/install/#for-developers-development-environment) -### Building for Production - -```bash -npm run build # Build for all browsers -npm run zip # Package for distribution (requires 7-Zip) -``` - -## Folder Structure - -The folder structure is as follows: - -- The `src` folder contains source files that are compiled to the build directory. - -- The `src/plugins` folder contains vital loaders required for BetterSEQTA+ functionality. - -- The `src/interface` folder contains source React & Svelte files that are required for the Settings page. - -- The `dist` folder is where the compiled code ends up, this is the folder what you need to load into chrome as an unpacked extension for development. +Full setup guide: +[https://betterseqta.github.io/BetterSEQTA-Docs/install/#for-developers-development-environment](https://betterseqta.github.io/BetterSEQTA-Docs/install/#for-developers-development-environment) ## Contributors @@ -120,6 +80,9 @@ Want to contribute? [Click Here!](https://docs.betterseqta.org/contributing/) ## Credits This extension was initially developed by [Nulkem](https://github.com/Nulkem/betterseqta), was ported to manifest V3 by [MEGA-Dawg68](https://github.com/MEGA-Dawg68) and is currently under active development from lead developers [SethBurkart123](https://github.com/SethBurkart123) and [Crazypersonalph](https://github.com/Crazypersonalph) with help from other volunteers. +Originally developed by [Nulkem](https://github.com/Nulkem/betterseqta) +Ported to Manifest V3 by [MEGA-Dawg68](https://github.com/MEGA-Dawg68) +Maintained by [SethBurkart123](https://github.com/SethBurkart123), [Crazypersonalph](https://github.com/Crazypersonalph) & the rest of the BetterSEQTA team! ## Star History From cef99b727873074cd9aed24ed022cf45b74f317f Mon Sep 17 00:00:00 2001 From: StroepWafel <109832156+StroepWafel@users.noreply.github.com> Date: Tue, 7 Apr 2026 19:55:06 +0930 Subject: [PATCH 3/4] Update README.md --- README.md | 27 +++++++++++++++++---------- 1 file changed, 17 insertions(+), 10 deletions(-) diff --git a/README.md b/README.md index 9a15d00b..8c9d7188 100644 --- a/README.md +++ b/README.md @@ -28,20 +28,27 @@ Includes: ## Features -- Dark mode + custom themes -- Improved UI / styling -- Custom home page (lessons, notices, assessments, shortcuts) -- Sidebar customisation +- Dark mode + - Custom Background/Themes +- Improved Styling/CSS + - Improved look for SEQTA Learn +- Custom Home Page including: + - Daily Lessons + - Shortcuts + - Easier Access Notices + - Assessments +- Options to remove certain items from the side menu - Grades calculator -- Theme system + theme store -- Lesson notifications -- Cross-browser support (Chromium + Firefox) -- Custom themes! - +- Fully customisable themes and an official theme store +- Notification for next lesson (sent 5 minutes before end of the lesson) +- Browser Support + - Chrome, Edge, Brave, Opera and other Chromium-Based browsers are supported + - Firefox Supported: [here](https://addons.mozilla.org/en-US/firefox/addon/betterseqta-plus/)! + - Safari (Experimental and not recommended - only available via compilation) ## Creating Custom Themes -If you are looking to create custom themes, I would recommend you start at the official documentation [here](https://docs.betterseqta.org/). You can see some premade examples along with a compilation script that can be used to allow for CSS frameworks and libraries such as SCSS to be used [here](https://github.com/BetterSEQTA/BetterSEQTA-Theme-Generator). +If you are looking to create custom themes, I would recommend you start at the official documentation [here](https://docs.betterseqta.org/theme-creation/). You can see some premade examples along with a compilation script that can be used to allow for CSS frameworks and libraries such as SCSS to be used [here](https://github.com/BetterSEQTA/BetterSEQTA-Theme-Generator). Don't worry- if you get stuck feel free to ask around in the [discord](https://discord.gg/YzmbnCDkat). We're open and happy to help out! Happy creating :) From 140cd66c9b8c2032971e45818ea082a06735a812 Mon Sep 17 00:00:00 2001 From: Aden Lindsay <140392385+AdenMGB@users.noreply.github.com> Date: Tue, 7 Apr 2026 21:09:55 +0930 Subject: [PATCH 4/4] chore: update old and non existant links --- README.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 8c9d7188..8b8c83fa 100644 --- a/README.md +++ b/README.md @@ -54,10 +54,9 @@ Don't worry- if you get stuck feel free to ask around in the [discord](https://d ## 🚀 Contributing **New contributors welcome!** -- 📖 Start here: https://betterseqta.github.io/BetterSEQTA-Docs/getting-started/ -- 🧠 Architecture: https://betterseqta.github.io/BetterSEQTA-Docs/architecture/ -- 🧩 Plugins: https://betterseqta.github.io/BetterSEQTA-Docs/plugins/ -- 🐛 Issues: https://github.com/BetterSEQTA/BetterSEQTA-plus/issues +- 📖 Start here: https://docs.betterseqta.org/install/ +- 🧠 Architecture: https://docs.betterseqta.org/architecture/ +- 🧩 Plugins: https://docs.betterseqta.org/plugins/ - 💬 Discord: https://discord.gg/YzmbnCDkat