hackforla / hackforla/peopledepot
Create high level diagrams to describe the project
Open
complexity: missing
draft
p-feature: Stakeholder documentation
PII: FALSE
ready for dev lead
role: technical writing
s: CTJ
s: hackforla.org
s: kb
s: PD team
s: VRMS
size: 3pt
- Dominant language
- Python
- Stars
- 14
- Forks
- 37
- Avg merge
- 9d 15h
- Merged PRs (30d)
- 5
Description
### Overview
We need to create diagrams to see the project at different levels of details for people reading our documentation. C4 is a simplified/popular(?) model for organizing diagrams for software projects.
### Action Items
- [ ] create system context diagram
- [ ] create container diagram
- [ ] ~~create component diagram~~
- [ ] ~~create code diagrams~~
### Resources/Instructions
- just the higher level diagrams should be good for now
- https://c4model.com
Contributor guide
Assessment
This issue has not been assessed yet.