-
Notifications
You must be signed in to change notification settings - Fork 18
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
T66 docs for tags and settings #355
Conversation
Hi, this is exactly what @seitela and I had in mind when writing the comment in #66. Like this the user has a resource to understand the concept behind these tags and settings. Regarding your questions:
I would say yes, maybe even a bit too detailed for lazy documentation readers who would only need an abstract to understand the concept. But having some examples is helpful I guess and the reader can still decide if they want to read the entire documentation.
If would prefer having a short summary in the README.md like for the Path Management which includes a link to the detailed documentation file. But I think that this is just my personal taste and we might have to discuss this in a meeting to get multiple opinions.
I guess you would like to link this page? I'm not sure but maybe we can set an internal link to this documentation page, however, I don't have any experience with this. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't test building the documentation but content-wise it looks good 👍
I'm currently working on #29 and refactor all the default settings into the respective adapters so that in the future the user only has to specify settings which deviate from the sensible defaults. We should add this to the documentation once it's implemented. |
An interesting information about the |
…iew before having to read the whole doc
Please check the following before creating the pull request (PR):
List any specific code review questions
Hi, just saw @TomTomRixRix 's recent comment about wanting more documentation for the tags and settings. Coincidentally I'd already written a little to help me understand it when I first arrived, so I've polished it a little and thought it may help.
Questions:
Provide issue / feature request fixed by this PR
Fixes #66