Open arpitbbhayani opened 1 month ago
Would love to take this up!
@souvik150 One slight change.
We have moved docs to the main Dice repository which can be found under the docs directory. The folder structure is the same and you can apply the same changes to the main repository.
Please comment on the same issue on the main Dice repository and raise the PR again. Once again, I'm sorry for the inconvenience.
We have taken this call to keep the doc and the code together allowing us to keep docs consistent with the code and everything to be part of one PR checklist.
Thanks for understanding.
The documentation of the command
[BFINIT](https://dicedb.io/commands/bfinit/)
present in this directory could have become stale. We need your help to ensure that the documentation is complete, correct, and consistent. Completing this issue will give you much-needed exposure to how the command is implemented and the different parameters it accepts. Hence, this is a great way to build a good understanding of the project and its functionality. While still making a significant contribution. Here's what you need to do:Note: The title of the sections should be the exact strings mentioned above, like "Examples", "Return values", etc. Note: The description of the command in Frontmatter of the command.md file is the first paragraph (introduction) of the command.
Go through the DiceDB/dice repository and explore the command implementation
Please use the documentation of the SET command as the reference point and structure the documentation of this command in a very similar way, including the following points
127.0.0.1:7379>
and not anything elseIf you find any inconsistencies, please fix the documentation in the
DiceDB/docs
repository and raise the PR. The core idea of this exercise is to ensure that the documentation is consistent, correct, and complete.Make sure you comment on the other issues you created (if any) as a comment on this issue and also any PR (if any) that you created. Thank you for picking this up and contributing to the DiceDB. It means a ton.