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

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

Open
BudHimself opened this issue Jul 4, 2024 · 3 comments
Open

Comments

@BudHimself
Copy link

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
Copy link
Contributor

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
Copy link
Author

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
Copy link
Contributor

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!

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

2 participants