Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add high-level documentation of system components and functions #960

Open
KlaasH opened this issue Dec 5, 2024 · 0 comments
Open

Add high-level documentation of system components and functions #960

KlaasH opened this issue Dec 5, 2024 · 0 comments
Assignees

Comments

@KlaasH
Copy link
Contributor

KlaasH commented Dec 5, 2024

This project has a fair number of components, and the overall shape of what they are and how they fit together is not currently documented in the main README or the ADRs, and having that written down is going to be important for enabling new people to work on the project.

So the task is to create a new documentation page cataloguing the components of the system and describing, in low-to-moderate detail, how they're set up and how they relate to each other.

@KlaasH KlaasH self-assigned this Dec 5, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant