teracyhq-incubator / teracy-dev-core

teracy-dev-core extension
MIT License
1 stars 6 forks source link

#12 | update readme with the section supported configuration #32

Closed hoavt closed 5 years ago

hoavt commented 6 years ago

connect #12

@hieptranquoc Please review this pr.

hieptranquoc commented 6 years ago

@hoavt It should be detailed, rather than listed. Specifies the function of each major configure.

hieptranquoc commented 6 years ago

@hoavt we can create example directory, and put config.example.yaml in it.

hoavt commented 6 years ago

@hoavt It should be detailed, rather than listed. Specifies the function of each major configure.

Their function are mentioned in the configuration file. Why do we need to rewrite them anymore? When we have any changes in the config file, we don;t need to change the README file anymore.

hoatle commented 6 years ago

it's expected that users should know how to use by referring docs, not the source code. Docs should explain in more details for what and why, which param is required, which is optional, what is the default value, etc.

hoatle commented 6 years ago

examples are expected for different config types: variables, plugins, default and nodes, etc.

hoavt commented 6 years ago

@hieptranquoc Please review, and add more examples for "default" and "variables". Moreover, which params need to be explained more, please help me to explain them. which param is required, which is optional...

hoavt commented 6 years ago

@hieptranquoc Please review the new commit.

hoavt commented 6 years ago

@hieptranquoc please review.

hoatle commented 6 years ago

need to split the examples into the following example configs:

how to run and expected outcome and behavior should be explained.