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 architecture documentation for the project. #1890

Merged
merged 1 commit into from Mar 10, 2024

Conversation

tim-schilling
Copy link
Contributor

This starts with high level information about the project. In the future we can go into more detail on each of the components.

Description

This is in response to reading https://matklad.github.io/2021/02/06/ARCHITECTURE.md.html

Checklist:

  • I have added the relevant tests for this change.
  • I have added an item to the Pending section of docs/changes.rst.

docs/architecture.rst Outdated Show resolved Hide resolved
Copy link
Member

@matthiask matthiask left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is excellent work, thank you!

This starts with high level information about the project.
In the future we can go into more detail on each of the components.
@tim-schilling tim-schilling merged commit 0baef8c into jazzband:main Mar 10, 2024
25 checks passed
@tim-schilling tim-schilling deleted the docs/architecture branch March 10, 2024 18:06
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

Successfully merging this pull request may close these issues.

None yet

3 participants