Sprout

Sprout Specification

This repository contains the technical specification, architecture documentation, and design decisions for Sprout.

Contents

Architecture

Technical documentation describing how Sprout works internally. This includes component diagrams, data flows, and explanations of core concepts.

• Overview — High-level architecture and design principles
• Resolution Hooks — How and when Sprout resolves tenant identities
• Tenancy Lifecycle — How tenants are identified, resolved, and managed
• Service Overrides — How Sprout integrates with Laravel’s service container
• Components — Detailed documentation for each component (Core, Bud, Seedling, Canopy)

RFCs

Request for Comments documents for proposing significant changes or new features. RFCs provide a structured way to discuss and evaluate proposals before implementation.

• RFC-0000: Template — Template for new RFCs
• RFC-0001: Seedling — Multi-Database Support — Multi-database support
• RFC-0002: Canopy — Domain-Based Tenant Identification — Domain-based tenant identification
• RFC-0003: Stacked Identity Resolution — Stacked Identity Resolution
• Index — List of all RFCs and their status

ADRs

Architecture Decision Records document significant technical decisions, their context, and rationale. ADRs help maintain a historical record of why things are built the way they are.

• ADR-0000: Template — Template for new ADRs
• ADR-0001: Monorepo v2 — Decision to consolidate addons into a single package
• Index — List of all ADRs

Contributing

If you’d like to propose a change to Sprout’s architecture or design, please:

1. For new features or significant changes, open an RFC
2. For implementation decisions within an accepted RFC, document them as ADRs
3. For clarifications or corrections to existing documentation, open a pull request

See CONTRIBUTING.md for general contribution guidelines.

Versioning

This specification tracks the development of Sprout v2. Documentation for v1 can be found in the main documentation.