Add CLI Documentation to Scribe-Data .rst File for list and total commands

[KesharwaniArpita]

Contributor checklist

• This pull request is on a separate branch and not the main branch

---

Description

This WIP PR adds a comprehensive section on the Command-Line Interface (CLI) of Scribe-Data to the existing .rst documentation. The update includes usage examples, available commands, and command options for interacting with Scribe-Data through the CLI. The following key sections have been added:

1. A brief introduction change to the CLI with the link to view the code on GitHub.
2. Implemented the list command for viewing available languages and data types. Example output of the command.
3. Implemented the total command to check the total available data for languages and types. Example usage and output.

Verified the syntax and content by running the commands and reviewing the output formatting.

This update provides clear documentation for users looking to interact with Scribe-Data via the command line. It also enhances the visibility of CLI options and behavior, making it easier to use and troubleshoot.

Related issue

• Expand documentation outputs for Scribe-Data commands #208

[github-actions]

Thank you for the pull request!

The Scribe team will do our best to address your contribution as soon as we can. The following is a checklist for maintainers to make sure this process goes as well as possible. Feel free to address the points below yourself in further commits if you realize that actions are needed :)

If you're not already a member of our public Matrix community, please consider joining! We'd suggest using Element as your Matrix client, and definitely join the General and Data rooms once you're in. Also consider joining our bi-weekly Saturday dev syncs. It'd be great to have you!

Maintainer checklist

• The linting and formatting workflow within the PR checks do not indicate new errors in the files changed

• The CHANGELOG has been updated with a description of the changes for the upcoming release and the corresponding issue (if necessary)

[KesharwaniArpita]

@mhmohona, @andrewtavis and @crocmons can you review the PR and provide your inputs ? I also wanted to ask you what how to proceed with the get commands? @crocmons, would you like to work on the get and convert commands?

[crocmons]

@KesharwaniArpita the pr looks good to me and yeah, I definitely love to work on it but since I'm a new contributor here can you guys @mhmohona @KesharwaniArpita guide me in this get and convert commands?

[andrewtavis]

Reviewing this and bringing it in now, @KesharwaniArpita :) Thanks so much for the review, @crocmons! Let's wait till #329 is merged and then we can look into convert. We could do get now though and maybe even the interactive mode! Maybe check the current docs and play around a bit, and from there we can discuss what needs to be added to the docs in the issue 😊

[KesharwaniArpita]

@KesharwaniArpita the pr looks good to me and yeah, I definitely love to work on it but since I'm a new contributor here can you guys @mhmohona @KesharwaniArpita guide me in this get and convert commands?

Hi @crocmons, have you setup your development environment?? If not you can read contributing.md and set it up(I'll recommend using SSH) and then read the Usage.md file and try on the basic get and convert commands. You would be able to run the scribe-data commands in the virtual environment you have created during the setup. Also there are less examples for get and convert commands in the Usage.md file, you can raise an issue(get it assigned to you) and a then a PR solvinghte issue once you get a hold of it. Does this make sense?