microsoft / microsoft/ebpf-for-windows
Use Mermaid for Architecture Diagrams
- Dominant language
- C
- Stars
- 3.6k
- Forks
- 311
- Avg merge
- 6d 10h
- Merged PRs (30d)
- 21
Description
### Describe the feature you'd like supported
I noticed your [architecture diagram](https://github.com/microsoft/ebpf-for-windows#architectural-overview) and thought it would be possible to use Mermaid instead to represent it.
### Proposed solution
See https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid for more details. For example:
```mermaid
graph LR;
source(eBPF program source)-->toolchain;
nesh(netsh CLI)-->ebpfnetsh.dll;
toolchain(existing toolchains)-->ebpfnetsh.dll;
toolchain-->epbfapi.dll;
ebpfnetsh.dll-->epbfapi.dll;
epbfapi.dll-->|eBPF program bytecode|ebpfsvc.dll;
```
It's pretty powerful, and fairly well documented. I think you can completely represent everything you have in your existing diagram this way.
### Additional context
https://mermaid-js.github.io/mermaid/#/flowchart
Contributor guide
Research direction
Start with the Architecture Overview in the repository README and compare the existing diagram with the proposed Mermaid flowchart in the issue. Replace the diagram with an accurate Mermaid representation of the same components and relationships, then verify that it renders correctly in GitHub Markdown.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- markdown
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 38/100