README-template.md

Subsystem name

🏠 Home

Description of the subsystem with the necessary context.

🚀 Usage

Explanation of how the subsystem is used.

📐 Design

Explain how the subsystem is designed, relevant implementation details, etc. Ideally include an Excalidraw diagram.

🔗 Relationship with other systems

Part of

• A single bullet for the parent subsystem. Link to the documentation of that subsystem if it exists.

Part of this

• One bullet point for each subsystem that is part of this one. Link to the documentation of those subsystems if it exists.

Used by this

• One bullet point for each subsystem used by this one, explaining why it uses it and how. Link to the documentation of those subsystems if it exists.

Uses this

• One bullet point for each subsystem using this one, explaining why it uses it and how. Link to the documentation of those subsystems if it exists.