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

Write an architecture explanation for easier understanding of the code #1799

Open
mwestphal opened this issue Dec 17, 2024 · 0 comments
Open

Write an architecture explanation for easier understanding of the code #1799

mwestphal opened this issue Dec 17, 2024 · 0 comments
Assignees
@mwestphal
Labels
type:documentation Improvements or additions to documentation
Milestone
3.1.0

Comments

@mwestphal
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Write a clear but exhaustive documentation of the architecture of the code so that its easier for new contributor to get into the project.

Describe the solution you'd like

  • Create a new /doc/dev/ARCHITECTURE.md
  • Write the content including, library, vtkext, application and so on
@mwestphal mwestphal added the type:documentation Improvements or additions to documentation label Dec 17, 2024
@mwestphal mwestphal added this to F3D Dec 17, 2024
@mwestphal mwestphal moved this to To do in F3D Dec 19, 2024
@mwestphal mwestphal self-assigned this Dec 19, 2024
@mwestphal mwestphal added this to the 3.1.0 milestone Dec 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@mwestphal mwestphal

Labels
type:documentation Improvements or additions to documentation
Projects
F3D
Status: To do
Milestone
3.1.0
Development

No branches or pull requests
1 participant
@mwestphal