Scribe-Data
Scribe-Data copied to clipboard
scribe-org
Expand documentation outputs for Scribe-Data commands
Terms
- [X] I have searched open and closed issues
- [X] I agree to follow Scribe-Data's Code of Conduct
Issue
This issue would be to expand the documentation of the Scribe-Data CLI with the full updated outputs of the commands. Each command should be ran, and the full process of the command should be inserted into code blocks. The file to change the documentation can be found here.
The documentation can be checked locally by:
# In local Scribe-Data director
cd docs
make html # run makefile
And then you can open up the docs/build/html/index.html file to see the current local state of the documentation.
Yes this would be a great one for you, @siva224513 :) Let me know if there's anything we can do to support!
Sure thing, @crocmons. @KesharwaniArpita, do you want to suggest a few changes you'd like to do, and now that you're more familiar we can also find further work to do that @crocmons can support with?
Hi @andrewtavis and @crocmons , do you think it would be helpful to start with the global commands and the list sub-commands? We would run each of the commands and insert the process and its output(or exemplary output) in the code blocks? Once we are done we can move to the sub-commands of get, total and convert?
Does this make sense?
@crocmons which one would you like to work on?
Bringing in @mhmohona into this conversation as the original implementer of the docs :)