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

Added template for command docs #1147

Merged
merged 3 commits into from
Oct 19, 2024

Conversation

apoorvyadav1111
Copy link
Contributor

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

@apoorvyadav1111 apoorvyadav1111 added documentation Improvements or additions to documentation enhancement labels Oct 18, 2024
@apoorvyadav1111
Copy link
Contributor Author

Hi @AshwinKul28, Please review this template. All the contributors can use this template for standard documentation.

Thanks,
Apoorv

@AshwinKul28
Copy link
Contributor

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.

@apoorvyadav1111
Copy link
Contributor Author

Hi @AshwinKul28 , updated the template with examples and more comments. Thanks for your suggestions.

@apoorvyadav1111 apoorvyadav1111 force-pushed the docs/add-template-for-docs branch from be09bf3 to 756a150 Compare October 18, 2024 21:01
@AshwinKul28
Copy link
Contributor

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.

@apoorvyadav1111
Copy link
Contributor Author

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.

@apoorvyadav1111
Copy link
Contributor Author

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.
Thanks

@AshwinKul28
Copy link
Contributor

Perfect, thanks for the changes @apoorvyadav1111 . LGTM

@AshwinKul28 AshwinKul28 merged commit c3400e8 into DiceDB:master Oct 19, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants