Improve Documentation and Welcome Message

eBPFDevSecTools / opened

OPENED Tool to extract specific eBPF functions from large monoliths (tested on Katran, Mizar, Cilium..)

Apache License 2.0

12 stars 6 forks source link

Improve Documentation and Welcome Message #27

Open Theophilusbenson opened 1 year ago

Theophilusbenson commented 1 year ago

Currently, the welcome README points viewers to the LPC presentation. We should include a summary and discuss highlilghts.

sdsen commented 1 year ago

@Theophilusbenson one suggestion is to create two pages 1. welcome page with broader intro. for need for devtools. We will move the code to a separate org, and then the welcome will go there.

The documentation improvement for extraction (goals, motivation, who are we building for ..) specifically can stay in this repo.

sdsen commented 1 year ago

For documentation, will be good to explain the contents of various artefacts generated in some details. Like structure of the file, implication of fields etc.