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

Add a template doc for describing the projects High-Level architecture #13

Closed
janhalen opened this issue Jun 19, 2024 · 3 comments · Fixed by #44
Closed

Add a template doc for describing the projects High-Level architecture #13

janhalen opened this issue Jun 19, 2024 · 3 comments · Fixed by #44
Assignees

Comments

@janhalen
Copy link
Member

janhalen commented Jun 19, 2024

Add an Architecture Overview

Should include

  • A diagram or description of the high-level architecture in a version controllable format
@janhalen janhalen self-assigned this Jun 19, 2024
@janhalen
Copy link
Member Author

I would recommend using Mermaid as the syntax/format for the diagram.

📚 Read more about Mermaid: https://docs.mermaidchart.com/mermaid/intro

@janhalen
Copy link
Member Author

janhalen commented Aug 7, 2024

An early preliminary version of a mermaid formatted architectural diagram is worked on here: https://github.com/OS2offdig/os2-docs-template/blob/13-add-a-template-doc-for-describing-the-projects-high-level-architecture/docs/architecture.md

The colours are terrible.. i know 😄

@janhalen
Copy link
Member Author

janhalen commented Oct 7, 2024

This could also be added to the README.md for more visibility..

The downside would be the space it takes up from other informations thus cluttering the README?

This could be solved by making a clear link to the diagram, and place it in a seperate "Architecture.md" - inspired by this article: https://johnjago.com/great-docs/

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
1 participant