search

scribe-org / Scribe-Data

Wikidata, Wiktionary and Wikipedia language data extraction
GNU General Public License v3.0
23 stars 25 forks source link

Documentation for CLI usage #165

Closed andrewtavis closed 1 month ago

andrewtavis commented 2 months ago

Terms

Description

This issue would look into documenting the commands for the Scribe-Data CLI. We'd need some of this to be on the project readme, and some of it to be within the docs 😊 Let's first discuss what's needed for this documentation, and from there implementation can start.

Contribution

@mhmohona will be working on this as a part of GSoC 2024 ☀️ As always, would be great to have you write in here, and let me know what you're thinking on documentation! :)

mhmohona commented 2 months ago

Lets discuss about it in our next call.

andrewtavis commented 2 months ago

Sounds good, @mhmohona!

andrewtavis commented 2 months ago

Do you want to do a call before the sync for this, @mhmohona, or just spend say 15/20 minutes on it there?

andrewtavis commented 1 month ago

I think that generally the documentation is good here, @mhmohona! I'll close this one, but please let me know if there's anything else you had in mind and we can reopen. Other additions could also be post gsoc issues for the community 😊

mhmohona commented 1 month ago

@andrewtavis,so after adding adding version and upgrade commands,the documentation will need to be updated as well.

andrewtavis commented 1 month ago

Hey @mhmohona 👋 I actually added little bits about those commands to the USAGE.md file and the docs, so I think we generally should be good :) Let's not worry too much more about this during GSoC as we have a bit more coding and the blogpost(s) to focus on :) Maybe you could also draft some social messages too? 😊

mhmohona commented 1 month ago

I will