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 structural documentation to the project #32

Open
dimasmith opened this issue Sep 23, 2023 · 1 comment
Open

Add structural documentation to the project #32

dimasmith opened this issue Sep 23, 2023 · 1 comment
Labels
documentation Improvements or additions to documentation
Milestone
0.1.0

Comments

@dimasmith
Copy link
Owner

The iris application should have documents that describe the structure and architecture of the application.
Desired documentaion should contain at least:

  • Structural diagrams of the application (e.g., C4 model)
  • Architectural decision records
@dimasmith dimasmith added the documentation Improvements or additions to documentation label Sep 23, 2023
@yashkite
Copy link

yashkite commented Sep 23, 2023 •
edited
Loading

can you describe more about this i can document things well

  • what type of design should be
  • what element has to be showcased to make the use case more effective
  • do you like the dedicated documentation file or inside the code file as a comments

@dimasmith dimasmith added this to the 0.1.0 milestone Sep 23, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
0.1.0
Development

No branches or pull requests
2 participants
@dimasmith @yashkite