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

Start β†’

Developer Path

Contributors to Structum

~45 min

Start β†’


πŸ‘€ 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ΒΆ

πŸ“– Configuration Philosophy

  • The 5-layer configuration model

  • Layer priorities and resolution

  • Best practices for each layer

Step 3: Deep Dive (Reference)ΒΆ

Topic

Guide

Configuration Engine

Configuration Getting Started

Logging & Metrics

Observability Stack

Production Patterns

Enterprise Architecture


πŸ‘¨β€πŸ’» 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ΒΆ

πŸ“– Configuration Philosophy

  • Core design principles

  • Plugin architecture

Step 3: Contribution GuidelinesΒΆ

Resource

Description

CONTRIBUTING.md

Complete contribution guidelines

ARCHITECTURE.md

System design documentation

ROADMAP.md

Development roadmap


πŸ“š All Guides ReferenceΒΆ

Guide

Description

Audience

User Tutorial

Installation to first plugin

Users

Developer Tutorial

Fork to contribution

Developers

Configuration Philosophy

5-layer model explained

All

Configuration Getting Started

Deep dive into config

Users

Observability Stack

Logging & Prometheus metrics

All

Enterprise Architecture

Production patterns

Advanced