containers / containers/netavark

Consider add some docs and images about the overall architecture

Open
#156 15 comments 0 reactions 0 assignees View on GitHub
documentation
Dominant language
Rust
Stars
794
Forks
161
Avg merge
8d 17h
Merged PRs (30d)
3

Description

It would be great to see how does this project work and how overall architecture is designed! Maybe adding some arch.md or some diagrams in the [./docs](https://github.com/containers/netavark/tree/main/docs) folder would be nice to have. 🙏

Contributor guide

Open the contributing guide

Research direction

Start by reviewing the existing material in the ./docs folder and the project structure to understand what architecture is already documented. Define an architecture overview in an arch.md file or diagrams, then confirm that the major components and their relationships are explained clearly for a new reader.

Written by the indexing model from the issue text.

Assessment

Tech stack
rust
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.