dev-cycles / contextive

Get on the same page.
https://contextive.tech
MIT License
244 stars 6 forks source link

Add some documentation about fields in the yaml configuration file #66

Open BudHimself opened 3 months ago

BudHimself commented 3 months ago

Is your feature request related to a problem? Please describe. Hi, i am starting to use this tool, but i don't find section in the documentation to explain which fields are available in the documentation.

Describe the solution you'd like Can you add a section in the documentation dedicated to this part ?

Thank you for your work.

chrissimon-au commented 3 months ago

Hi there, the best page for documentation of the file fields is: https://github.com/dev-cycles/contextive/blob/main/docs/wiki/USAGE.md

The example on that page illustrates all possible fields, but everything is optional.

Let me know if anything could be more clear!

BudHimself commented 3 months ago

Thank you for your quick reply.

I have a better understand on which field are usable now.

I know those key-words fields are very clear "by design". But maybe you could add a section to describe in few words and list them.

Because your example is also clear, but usually example does not support every features. So i was searching a section to tell me "this field do this", "in this part there is this fields available".

chrissimon-au commented 3 months ago

Understood - I will look at adding a file specification/reference documentation pages that lays out each field and how it is to be used. Thanks for the feedback and suggestion!