SethBurkart123
2.6 KiB
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.
Table of Contents
Getting Started
- Project Overview - This file
- Installation Guide - How to install and set up BetterSEQTA+
- Getting Started Contributing - Start here! Complete beginner-friendly guide
- Architecture Guide - How BetterSEQTA+ works under the hood
- Contributing Guide - Official contribution guidelines
- Troubleshooting - Common issues and solutions
Plugin System
- Creating Your First Plugin - A comprehensive, beginner-friendly guide to creating plugins
- Plugin API Reference - Detailed technical documentation of the plugin APIs
Core Concepts
BetterSEQTA+ is built around several core concepts:
-
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 to learn how to create your own!
-
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.
-
Storage API: Plugins can use the Storage API to persist data between sessions. The Storage API is also type-safe, ensuring that plugins can only access their own data.
-
SEQTA Integration: BetterSEQTA+ integrates with SEQTA Learn by injecting code into the page. This allows plugins to modify the SEQTA UI and add new features.
Getting Help
If you need help with BetterSEQTA+, you can:
- Open an Issue - Report bugs or request features
- Join the Discord - Chat with the community
- Email the Maintainers - 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:
- Fork the repository
- Make your changes to the documentation files
- Submit a pull request with a clear description of your changes
License
BetterSEQTA+ is licensed under the MIT License.