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.

Sign up for GitHub

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

Jump to bottom

Add more architectural documentation #43

Open
2 tasks
termi-official opened this issue Nov 16, 2023 · 0 comments
Open
2 tasks

Add more architectural documentation #43

termi-official opened this issue Nov 16, 2023 · 0 comments
Labels
architecture Issues affecting the structural and design aspects of the software documentation Improvements or additions to documentation high-priority

Comments

@termi-official
Copy link
Owner

The docs should be improved by adding

  • Sequence diagrams for the internal workflow from model to solver
  • Flow chart on internal component dependencies

This can be done via https://github.com/JuliaDocs/DocumenterMermaid.jl
@termi-official termi-official added documentation Improvements or additions to documentation architecture Issues affecting the structural and design aspects of the software high-priority labels Nov 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
architecture Issues affecting the structural and design aspects of the software documentation Improvements or additions to documentation high-priority
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@termi-official