BetterSEQTA/BetterSEQTA-Plus
1
0
Fork 0
mirror of https://github.com/BetterSEQTA/BetterSEQTA-Plus.git synced 2026-06-06 03:34:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: improve plugin documentation

Browse Source
This commit is contained in:
SethBurkart123
2025-03-31 19:25:06 +11:00
parent 77582a4d00
commit 68e8c89b35
10 changed files with 531 additions and 1582 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+3 -13
View File
@@ -12,24 +12,14 @@ Welcome to the BetterSEQTA+ documentation! This documentation will help you unde
- [Contributing Guide](../CONTRIBUTING.md) - How to contribute to BetterSEQTA+
### Plugin System
- [Plugin System Overview](./plugins/README.md) - Overview of the plugin system
- [Creating Your First Plugin](./plugins/creating-plugins.md) - Guide to creating a simple plugin
### Settings System
- [Settings System Overview](./settings/README.md) - How the type-safe settings system works
- [Creating Plugins with Settings](./settings/creating-plugins.md) - How to use the decorator-based settings in plugins
- [Creating Custom UI Components](./settings/custom-ui-components.md) - How to create custom UI components for settings
### Advanced Topics
- [TypeScript Type System](./advanced/typescript.md) - How BetterSEQTA+ leverages TypeScript for type safety
- [Plugin API Reference](./advanced/plugin-api.md) - Detailed reference for the Plugin API
- [Storage API Reference](./advanced/storage-api.md) - Detailed reference for the Storage API
- [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
## 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.
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!
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.