Skip to content
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.

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

Need for documentation #21

Open
dluc opened this issue Aug 18, 2022 · 0 comments
Open

Need for documentation #21

dluc opened this issue Aug 18, 2022 · 0 comments

Comments

@dluc
Copy link
Collaborator

dluc commented Aug 18, 2022

For a new adopter, aside from the examples, it's quite hard understanding how to configure the engines. There are a few areas that could use some extra docs:

  • types.cs: documenting all the properties, explaining what they do, when to change them
  • add more comments in the examples, explaining what each line is doing and why
  • organize examples in 2 groups: configuring engines programmatically vs configuring engines via YAML files
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant