[Jane Dane]

Architecture

This page describes how the application is structured and how important parts of the app work. It should give a new-joiner sufficient technical knowledge for contributing to the codebase.

See this blog post for an explanation of the concept and these examples:

• https://github.com/rust-lang/rust-analyzer/blob/master/docs/dev/architecture.md
• https://github.com/Uriopass/Egregoria/blob/master/ARCHITECTURE.md
• https://github.com/davish/obsidian-full-calendar/blob/main/src/README.md

For structural and behavioral illustration, you might want to leverage Mermaid, e.g., by charting common C4 or UML diagrams.

You may delete this attention box.

Table of contents

• Overview
• Codemap
• Cross-cutting concerns

Overview

[Give a high-level overview of what your app does and how it achieves it: similar to the value proposition, but targeted at a fellow developer who wishes to contribute.]

Codemap

[Describe how your app is structured. Don’t aim for completeness, rather describe just the most important parts.]

Cross-cutting concerns

[Describe anything that is important for a solid understanding of your codebase. Most likely, you want to explain the behavior of (parts of) your application. In this section, you may also link to important design decisions.]