Skip to content
New issue

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

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

Already on GitHub? # to your account

13 add a template doc for describing the projects high level architecture #44

Conversation

janhalen
Copy link
Member

@janhalen janhalen commented Oct 7, 2024

Proposing a diagram template placed in /docs/architecture.md

Currently theres no link from the README.md ...

@janhalen janhalen linked an issue Oct 7, 2024 that may be closed by this pull request
Copy link
Member

@zorp zorp left a comment

Choose a reason for hiding this comment

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

Great example. I am missing an introduction text explaining or linking to a guide explaining how a diagram can be made (if any). Might be something that should be covered in the readme.

@janhalen
Copy link
Member Author

Discussed the review with @zorp...

Came up with these suggestions:

  1. We should add why Mermaid is the chosen format
  2. Link to getting started with - mermaid guides...
  3. Intro explaining what is this diagram delivering (business value)

@janhalen
Copy link
Member Author

janhalen commented Dec 4, 2024

@zorp: Changes implemented... ready for merge if you can accept the implemented changes. ➡️ https://github.com/OS2offdig/os2-docs-template/blob/13-add-a-template-doc-for-describing-the-projects-high-level-architecture/docs/architecture.md

@zorp zorp merged commit 7c5b463 into main Dec 4, 2024
3 checks passed
@zorp zorp deleted the 13-add-a-template-doc-for-describing-the-projects-high-level-architecture branch December 4, 2024 18:54
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add a template doc for describing the projects High-Level architecture
2 participants