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 an ARCHITECTURE.md fle describing the archticture of the F3D project #1887

Open
mwestphal opened this issue Jan 6, 2025 · 2 comments
Open

Add an ARCHITECTURE.md fle describing the archticture of the F3D project #1887

mwestphal opened this issue Jan 6, 2025 · 2 comments
Assignees
@GaganCodes
Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation

Comments

@mwestphal
Copy link
Contributor

Is your feature request related to a problem? Please describe.
While the documentation is good for dev, one thing that is missing is a high level architecture documentation explaining how the project is structured.

Describe the solution you'd like
Add a doc/dev/ARCHITECTURE.md which should explain what are the different folder for, what do they contain and how they interact with each other in the different processes.
@mwestphal mwestphal added type:documentation Improvements or additions to documentation help wanted Please help with this issue! labels Jan 6, 2025
@mwestphal mwestphal added this to F3D Jan 6, 2025
@GaganCodes
Copy link

Hi @mwestphal, commenting for assignment. Thanks!

@mwestphal
Copy link
Contributor Author

Assigned :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@GaganCodes GaganCodes

Labels
help wanted Please help with this issue! type:documentation Improvements or additions to documentation
Projects
F3D
Status: No status
Milestone
No milestone
Development

No branches or pull requests
2 participants
@mwestphal @GaganCodes