-
Notifications
You must be signed in to change notification settings - Fork 1.2k
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
Added template for command docs #1147
Added template for command docs #1147
Conversation
Hi @AshwinKul28, Please review this template. All the contributors can use this template for standard documentation. Thanks, |
Thanks a lot, @apoorvyadav1111 for this. This is a robust documentation example that can be followed throughout. Great! Please have a look on couple of thoughts. |
Hi @AshwinKul28 , updated the template with examples and more comments. Thanks for your suggestions. |
be09bf3
to
756a150
Compare
Amazing thanks. one last thought @apoorvyadav1111 , This looks more like a perfect ideal example than a template, shall we have a separate file just for the template having all sections/subsections where users can pick and start adding their content and this in a separate file or top/bottom in template file as an ideal example? I feel the template should be more generalized. wdyt? I'm just thinking from general audience. |
Hi @AshwinKul28 . This sounds even better what we have right now. So we can have a sample_doc file which can have all sections (notes, depreciation warnings) etc from different commands as an example. Additionally, We can have a template_doc which is just for structure with no comments and no text. Please confirm my understanding about the requirements. |
Hi @AshwinKul28 , added template and sample separately. Currently, all docs have some deviation from each other which should not be a time consuming task but will have multiple files being affected. Once this is approved, we can fix those headings. |
Perfect, thanks for the changes @apoorvyadav1111 . LGTM |
Hi team,
Added an empty .md file for command docs based on
SET
documentation. It is to be used by contributors for auditing and added documentation.Thanks
Apoorv