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.

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

Architecture.md #66

Open
TechSupportJosh opened this issue Feb 7, 2021 · 0 comments
Open

Architecture.md #66

TechSupportJosh opened this issue Feb 7, 2021 · 0 comments
Labels
enhancement New feature or request

Comments

@TechSupportJosh
Copy link
Collaborator

Is your feature request related to a problem? Please describe.
For new people contributing, trying to find where to make changes and where functions are is often confusing.

Describe the solution you'd like
We can add an architecture.md document to the root of this repo. We'd likely need it split into 2 parts, one for the building of Netkit and another for how Netkit actually runs.

While our project is not massive, the documentation of it will ensure people will continue to make changes in the future.

See https://matklad.github.io//2021/02/06/ARCHITECTURE.md.html

@TechSupportJosh TechSupportJosh added the enhancement New feature or request label Feb 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant