Guides & Learning PathsΒΆ
Welcome to the Structum learning center! Choose your path based on your goals.
π― Choose Your PathΒΆ
Path |
For |
Duration |
Start |
|---|---|---|---|
User Path |
Application developers using Structum |
~30 min |
|
Developer Path |
Contributors to Structum |
~45 min |
π€ User Path: From Install to PluginΒΆ
Goal: Learn to use Structum in your applications.
Step 1: Installation & First StepsΒΆ
π User Tutorial
Clone and install from source
Create your first configuration
Run with different environments
Build a custom plugin
Step 2: Understand the ArchitectureΒΆ
The 5-layer configuration model
Layer priorities and resolution
Best practices for each layer
Step 3: Deep Dive (Reference)ΒΆ
Topic |
Guide |
|---|---|
Configuration Engine |
|
Logging & Metrics |
|
Production Patterns |
π¨βπ» Developer Path: ContributingΒΆ
Goal: Contribute code, docs, or plugins to Structum.
Step 1: Environment SetupΒΆ
π Developer Tutorial
Fork and clone the repository
Install development dependencies
Configure pre-commit hooks
Run tests and type checks
Step 2: Understand the CodebaseΒΆ
Core design principles
Plugin architecture
Step 3: Contribution GuidelinesΒΆ
Resource |
Description |
|---|---|
CONTRIBUTING.md |
Complete contribution guidelines |
System design documentation |
|
ROADMAP.md |
Development roadmap |
π All Guides ReferenceΒΆ
Guide |
Description |
Audience |
|---|---|---|
Installation to first plugin |
Users |
|
Fork to contribution |
Developers |
|
5-layer model explained |
All |
|
Deep dive into config |
Users |
|
Logging & Prometheus metrics |
All |
|
Production patterns |
Advanced |