Add some documentation about fields in the yaml configuration file

[BudHimself]

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]

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]

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]

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!

[chrissimon-au]

This is not yet a true 'reference' page, but it does have more thorough documentation of all fields now: https://docs.contextive.tech/ide/guides/defining-terminology/

Leving this ticket open until we have a 'schema reference' page

[chrissimon-au]

Also noting that the schema is now registered with JSON Schema Store: https://json.schemastore.org/contextive-glossary.json

So if using one of the supported editors there should be built in support for schema documentation: https://www.schemastore.org/json/#editors

Still leaving this open until we have a 'schema reference' page in the docs.