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

docs(docs): Add standardized architecture document structure #8

Merged
merged 2 commits into from
Nov 15, 2023

Conversation

stevenj
Copy link
Collaborator

@stevenj stevenj commented Nov 15, 2023

Description

Adds arc42 architecture documents following the standard defined in catalyst-ci.
Also adds the first ADR to the repo, about arc42 and our ADR system itself.

Please confirm the following checks

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream module

@stevenj stevenj merged commit f589bce into main Nov 15, 2023
18 of 19 checks passed
@stevenj stevenj deleted the feat/ArchitectureDocs branch November 15, 2023 08:16
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.

1 participant