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

More and better documentation #85

Open

4 tasks

MateuszKowalewski opened this issue Jul 1, 2023 · 0 comments

Labels

Contributor

MateuszKowalewski commented Jul 1, 2023

For someone looking into this from the outside much more documentation is needed.

Add much more doc comments. That's kind of baseline.
Add more comments explaining how the usage side of the code (test projects) are intended to work.
Describe the overall code structure. How is the DSL structured? How is it implemented?
Add some reference. (Could be maybe extracted form doc comments on the DSL)

I'll extend this issue in case I would have more requests for documentation… 😄

TomasMikula added the documentation label

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