Skip to content

Need for documentation #21

@dluc

Description

@dluc

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions