diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 70abc987..b168fda2 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,9 +6,9 @@ Hey there! ๐Ÿ‘‹ Thanks for your interest in contributing to BetterSEQTA+! We're **Never contributed to an open source project before?** No worries! We've made it super easy to get started: -- **๐Ÿ“– Read our [Getting Started Guide](./docs/GETTING_STARTED_CONTRIBUTING.md)** - This walks you through everything step-by-step, from setting up your development environment to making your first pull request. -- **๐Ÿ—๏ธ Understand the codebase** with our [Architecture Guide](./docs/ARCHITECTURE.md) -- **๐Ÿ”ง Having issues?** Check our [Troubleshooting Guide](./docs/TROUBLESHOOTING.md) +- **๐Ÿ“– Read our [contributing guide](https://docs.betterseqta.org/contributing/)** - This walks you through everything step-by-step, from setting up your development environment to making your first pull request. +- **๐Ÿ—๏ธ Understand the codebase** with the [architecture guide](https://docs.betterseqta.org/architecture/) +- **๐Ÿ”ง Having issues?** Check the [troubleshooting guide](https://docs.betterseqta.org/troubleshooting/) We have lots of [`good first issue`](https://github.com/BetterSEQTA/BetterSEQTA-plus/labels/good%20first%20issue) labels that are perfect for beginners! @@ -33,8 +33,8 @@ Join our community channels to discuss the project, get help, and connect with o If you're interested in creating plugins for BetterSEQTA+, check out our plugin development guides: -- [Creating Your First Plugin](./docs/plugins/creating-plugins.md) -- [Plugin API Reference](./docs/advanced/plugin-api.md) +- [Plugin development](https://docs.betterseqta.org/plugin-development/) +- [Plugin API](https://docs.betterseqta.org/plugin-api/) ## Pull Request Process diff --git a/README.md b/README.md index 2726211f..8b8c83fa 100644 --- a/README.md +++ b/README.md @@ -16,17 +16,15 @@ -## 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 @@ -50,64 +48,32 @@ ## 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/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 :) -## ๐Ÿš€ Want to Contribute? +## ๐Ÿš€ Contributing +**New contributors welcome!** +- ๐Ÿ“– Start here: https://docs.betterseqta.org/install/ +- ๐Ÿง  Architecture: https://docs.betterseqta.org/architecture/ +- ๐Ÿงฉ Plugins: https://docs.betterseqta.org/plugins/ +- ๐Ÿ’ฌ 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](./docs/GETTING_STARTED_CONTRIBUTING.md#your-first-30-minutes) -### 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 @@ -115,11 +81,14 @@ 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 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 diff --git a/docs/ARCHITECTURE.md b/docs/ARCHITECTURE.md index 0867d0e2..3f67efc0 100644 --- a/docs/ARCHITECTURE.md +++ b/docs/ARCHITECTURE.md @@ -1,5 +1,7 @@ # BetterSEQTA+ Architecture +**Published version:** [docs.betterseqta.org/architecture/](https://docs.betterseqta.org/architecture/) + Hey there! ๐Ÿ‘‹ New to the codebase and feeling a bit lost? Don't worry - this guide will help you understand how everything fits together! ## Table of Contents @@ -221,7 +223,7 @@ console.log(settingsState.[the setting name]) Ready to contribute? Here's what to do next: 1. **Read the code**: Start with `src/SEQTA.ts` and follow the flow -2. **Try creating a simple plugin**: Follow our [plugin guide](./plugins/README.md) +2. **Try creating a simple plugin**: Follow the [plugin documentation](https://docs.betterseqta.org/plugins/) 3. **Look at existing issues**: Check our [GitHub issues](https://github.com/BetterSEQTA/BetterSEQTA-plus/issues) for "good first issue" labels 4. **Join our Discord**: Get help from the community! diff --git a/docs/GETTING_STARTED_CONTRIBUTING.md b/docs/GETTING_STARTED_CONTRIBUTING.md index b4d49feb..a51d39a1 100644 --- a/docs/GETTING_STARTED_CONTRIBUTING.md +++ b/docs/GETTING_STARTED_CONTRIBUTING.md @@ -1,5 +1,7 @@ # Getting Started as a Contributor +**Published version:** [docs.betterseqta.org/contributing/](https://docs.betterseqta.org/contributing/) + Welcome to BetterSEQTA+! ๐ŸŽ‰ This guide will walk you through making your first contribution, even if you're completely new to the project. ## Table of Contents @@ -222,7 +224,7 @@ git push origin your-branch-name ### Stuck? Here's How to Get Unstuck -1. **Check the docs** - [Architecture guide](./ARCHITECTURE.md) explains everything +1. **Check the docs** - The [architecture guide](https://docs.betterseqta.org/architecture/) explains everything 2. **Search existing issues** - Someone might have had the same problem 3. **Ask in Discord** - Our community is super helpful 4. **Create an issue** - If you found a bug or need help diff --git a/docs/README.md b/docs/README.md index 80b70850..b5e0e7a5 100644 --- a/docs/README.md +++ b/docs/README.md @@ -1,30 +1,36 @@ # BetterSEQTA+ Documentation -๐Ÿšง DOCS UNDER CONSTRUCTION! ๐Ÿšง - -Welcome to the BetterSEQTA+ documentation! This documentation will help you understand how BetterSEQTA+ works and how to extend it with plugins and new features. +**Canonical documentation lives at [docs.betterseqta.org](https://docs.betterseqta.org/).** The pages below are the same topics; use the site for search, navigation, and the latest updates. ## Table of Contents ### Getting Started -- [Project Overview](./README.md) - This file -- [Installation Guide](./installation.md) - How to install and set up BetterSEQTA+ -- [Getting Started Contributing](./GETTING_STARTED_CONTRIBUTING.md) - **Start here!** Complete beginner-friendly guide -- [Architecture Guide](./ARCHITECTURE.md) - How BetterSEQTA+ works under the hood -- [Contributing Guide](../CONTRIBUTING.md) - Official contribution guidelines -- [Troubleshooting](./TROUBLESHOOTING.md) - Common issues and solutions +- [Documentation home](https://docs.betterseqta.org/) +- [Installation](https://docs.betterseqta.org/install/) +- [Contributing](https://docs.betterseqta.org/contributing/) +- [Architecture](https://docs.betterseqta.org/architecture/) +- [Contribution guidelines (repository)](../CONTRIBUTING.md) +- [Troubleshooting](https://docs.betterseqta.org/troubleshooting/) -### Plugin System +### Features & customization -- [Creating Your First Plugin](./plugins/README.md) - A comprehensive, beginner-friendly guide to creating plugins -- [Plugin API Reference](./plugins/api-reference.md) - Detailed technical documentation of the plugin APIs +- [Features](https://docs.betterseqta.org/features/) +- [Themes & customization](https://docs.betterseqta.org/customization/) +- [Theme creation](https://docs.betterseqta.org/theme-creation/) + +### Plugin system + +- [Plugins overview](https://docs.betterseqta.org/plugins/) +- [Plugin development](https://docs.betterseqta.org/plugin-development/) +- [Plugin API](https://docs.betterseqta.org/plugin-api/) +- [Example plugin](https://docs.betterseqta.org/example-plugin/) ## Core Concepts BetterSEQTA+ is built around several core concepts: -1. **Plugin System**: BetterSEQTA+ uses a plugin system to extend SEQTA with new features. Plugins are self-contained pieces of code that can be enabled or disabled by the user. Check out our [plugin guide](./plugins/README.md) to learn how to create your own! +1. **Plugin System**: BetterSEQTA+ uses a plugin system to extend SEQTA with new features. Plugins are self-contained pieces of code that can be enabled or disabled by the user. See the [plugins documentation](https://docs.betterseqta.org/plugins/). 2. **Type-Safe Settings**: Each plugin can define settings that are type-safe and automatically rendered in the settings UI. The settings system uses TypeScript decorators to make it easy to define settings with proper typing. @@ -36,19 +42,13 @@ BetterSEQTA+ is built around several core concepts: If you need help with BetterSEQTA+, you can: -- [Open an Issue](https://github.com/SeqtaLearning/betterseqta-plus/issues) - Report bugs or request features +- [Open an Issue](https://github.com/BetterSEQTA/BetterSEQTA-Plus/issues) - Report bugs or request features - [Join the Discord](https://discord.gg/YzmbnCDkat) - Chat with the community - [Email the Maintainers](mailto:betterseqta.plus@gmail.com) - Contact the maintainers directly ## Contributing to the Documentation -We welcome contributions to the documentation! If you find something unclear or missing, please open an issue or submit a pull request. - -To contribute to the documentation: - -1. Fork the repository -2. Make your changes to the documentation files -3. Submit a pull request with a clear description of your changes +We welcome contributions to the documentation. The published site is built from the documentation repository; see [Contributing](https://docs.betterseqta.org/contributing/) for how to help. ## License diff --git a/docs/THEME_CREATION.md b/docs/THEME_CREATION.md index 100136b2..cd72cfd6 100644 --- a/docs/THEME_CREATION.md +++ b/docs/THEME_CREATION.md @@ -1,5 +1,7 @@ # Theme Creation Guide +**Published version:** [docs.betterseqta.org/theme-creation/](https://docs.betterseqta.org/theme-creation/) + This guide covers everything you need to know about creating custom themes for BetterSEQTA+. ## Table of Contents diff --git a/docs/TROUBLESHOOTING.md b/docs/TROUBLESHOOTING.md index 1302ec34..304c6cf6 100644 --- a/docs/TROUBLESHOOTING.md +++ b/docs/TROUBLESHOOTING.md @@ -1,5 +1,7 @@ # Troubleshooting Guide +**Published version:** [docs.betterseqta.org/troubleshooting/](https://docs.betterseqta.org/troubleshooting/) + Having issues with BetterSEQTA+ development? This guide covers the most common problems and their solutions. ## Table of Contents diff --git a/docs/contributing.md b/docs/contributing.md index 4f5334e3..4b50bc4c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -1,5 +1,7 @@ # Contributing to BetterSEQTA+ +**Published version:** [docs.betterseqta.org/contributing/](https://docs.betterseqta.org/contributing/) + Thank you for your interest in contributing to BetterSEQTA+! This document provides guidelines and instructions for contributing to the project. ## Table of Contents @@ -57,7 +59,7 @@ Key points: 5. **Install in Chrome/Firefox** - Follow the [installation instructions](./installation.md#development-installation) to load the development version into your browser. + Follow the [installation instructions](https://docs.betterseqta.org/install/) to load the development version into your browser. ### Project Structure @@ -246,8 +248,8 @@ Join our community channels to discuss the project, get help, and connect with o If you're interested in creating plugins for BetterSEQTA+, check out our plugin development guides: -- [Creating Your First Plugin](./plugins/creating-plugins.md) -- [Plugin API Reference](./advanced/plugin-api.md) +- [Plugin development](https://docs.betterseqta.org/plugin-development/) +- [Plugin API](https://docs.betterseqta.org/plugin-api/) ## Recognition diff --git a/docs/installation.md b/docs/installation.md index 0e5c8514..627b4966 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -1,5 +1,7 @@ # Installing BetterSEQTA+ +**Published version:** [docs.betterseqta.org/install/](https://docs.betterseqta.org/install/) + This guide will walk you through the process of installing and setting up BetterSEQTA+ for development or usage. ## Prerequisites @@ -178,5 +180,5 @@ bun run dev Now that you have BetterSEQTA+ installed, you can: -- [Getting Started with Plugins](./plugins/getting-started.md) -- [Contribute to the project](../CONTRIBUTING.md) +- [Plugins](https://docs.betterseqta.org/plugins/) +- [Contribute to the project](https://docs.betterseqta.org/contributing/) ยท [Repository CONTRIBUTING.md](../CONTRIBUTING.md) diff --git a/docs/plugins/EXAMPLE_PLUGIN.md b/docs/plugins/EXAMPLE_PLUGIN.md index 517752c0..f26acd78 100644 --- a/docs/plugins/EXAMPLE_PLUGIN.md +++ b/docs/plugins/EXAMPLE_PLUGIN.md @@ -1,5 +1,7 @@ # Example Plugin Template +**Published version:** [docs.betterseqta.org/example-plugin/](https://docs.betterseqta.org/example-plugin/) + This is a complete, working example of a simple BetterSEQTA+ plugin. You can copy this code and modify it to create your own plugin! ## What This Example Does @@ -328,8 +330,8 @@ Once you've got this working: ## Need Help? - ๐Ÿ’ฌ Ask in our [Discord server](https://discord.gg/YzmbnCDkat) -- ๐Ÿ“š Read our [Plugin Development Guide](./README.md) -- ๐Ÿ› Check the [Troubleshooting Guide](../TROUBLESHOOTING.md) +- ๐Ÿ“š Read the [plugin documentation](https://docs.betterseqta.org/plugins/) +- ๐Ÿ› Check the [troubleshooting guide](https://docs.betterseqta.org/troubleshooting/) - ๐Ÿ“ Open an issue on GitHub Happy coding! ๐ŸŽ‰ \ No newline at end of file diff --git a/docs/plugins/README.md b/docs/plugins/README.md index 35510f09..7e64853f 100644 --- a/docs/plugins/README.md +++ b/docs/plugins/README.md @@ -1,5 +1,7 @@ # Creating Plugins for BetterSEQTA+ +**Published version:** [docs.betterseqta.org/plugins/](https://docs.betterseqta.org/plugins/) ยท [Plugin development](https://docs.betterseqta.org/plugin-development/) ยท [Plugin API](https://docs.betterseqta.org/plugin-api/) + Hey there! ๐Ÿ‘‹ So you want to create a plugin for BetterSEQTA+? That's awesome! This guide will walk you through everything you need to know, from the very basics to more advanced features. Don't worry if you're new to this - we'll explain everything step by step. ## What is a Plugin? @@ -294,4 +296,4 @@ Got stuck? No worries! Here's where you can get help: - Check out the built-in plugins in the `src/plugins/built-in` folder - Open an issue on our [GitHub page](https://github.com/betterseqta/betterseqta-plus/issues) -Happy coding and feel free to checkout the api reference [here](./api-reference.md) +Happy coding and feel free to check out the [plugin API](https://docs.betterseqta.org/plugin-api/) on the documentation site. diff --git a/docs/plugins/api-reference.md b/docs/plugins/api-reference.md index c057a277..620106a4 100644 --- a/docs/plugins/api-reference.md +++ b/docs/plugins/api-reference.md @@ -1,6 +1,8 @@ # Plugin API Reference -This document provides detailed technical information about BetterSEQTA+'s plugin APIs. For a beginner-friendly introduction, see [Creating Your First Plugin](./README.md). +**Published version:** [docs.betterseqta.org/plugin-api/](https://docs.betterseqta.org/plugin-api/) + +This document provides detailed technical information about BetterSEQTA+'s plugin APIs. For a beginner-friendly introduction, see the [plugins section](https://docs.betterseqta.org/plugins/) at [docs.betterseqta.org](https://docs.betterseqta.org/). ## Plugin Structure diff --git a/src/interface/components/store/CloudHeader.svelte b/src/interface/components/store/CloudHeader.svelte index 421b8dfd..1c8aca05 100644 --- a/src/interface/components/store/CloudHeader.svelte +++ b/src/interface/components/store/CloudHeader.svelte @@ -3,6 +3,11 @@ import { cloudAuth } from "@/seqta/utils/CloudAuth"; import CloudLoginForm from "./CloudLoginForm.svelte"; + let { alwaysShowUserName = false } = $props<{ + /** When true (e.g. narrow extension popup), show display name below sm breakpoint */ + alwaysShowUserName?: boolean; + }>(); + let cloudState = $state(cloudAuth.state); let open = $state(false); let dropdownEl: HTMLElement; @@ -65,7 +70,11 @@ {getInitials()} {/if} -