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

Improve entry point documentation #20

Closed

LucPrestin opened this issue May 8, 2022 · 1 comment

Labels

type::documentation

Owner

LucPrestin commented May 8, 2022

As someone interested in program traces, I'd like to have a better documentation of the entry points in order to not forget what I wanted to do.

Describe the solution you'd like

There is currently some information missing in the documentation:

Specific examples for the entry points
- add more
- make them a specific code snippet
What part of the system are we learning about here?
How can I group these entries? How to tackle this?
When looking at the generated stuff and find out some insights: how can I document these and add that to the data structure?
- add names of related packages
- use colors
- ...

LucPrestin added type::documentation type::enhancement labels

LucPrestin removed the type::enhancement label

Owner Author

LucPrestin commented Aug 7, 2022

Now part of #61

LucPrestin closed this as completed

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment