search

shuru-project / shuru

A task runner and version manager for Node.js and Python, written in Rust!
MIT License
16 stars 6 forks source link

Good First Issue: Create Documentation in `/docs` (Markdown) #7

Open harshdoesdev opened 1 month ago

harshdoesdev commented 1 month ago

Good First Issue: Create Documentation in /docs (Markdown)

Background

Shuru would benefit from dedicated documentation to provide users with more in-depth information on how to use the tool, beyond what's available in the README. Having a /docs folder with Markdown files would allow us to organize this information effectively.

Task

  1. Create a /docs Directory: Set up a folder to hold the documentation.
  2. Write Detailed Docs: Include sections like:
    • Getting Started
    • Configuration (shuru.toml examples)
    • Node.js Version Manager
    • Python Version Manager
    • Advanced Usage
  3. Organize Content: Ensure the content is well-organized and easy to navigate.

Steps to Complete:

  1. Create a new /docs folder.
  2. Write individual Markdown files for each major section of the documentation.
  3. Link these documents from the README and make sure the structure is easy to follow.
harshdoesdev commented 1 month ago

Related discussion: https://github.com/harshdoesdev/shuru/discussions/2

oyerohabib commented 1 month ago

Well done on this @harshdoesdev , really well written šŸ‘.

a-wishie commented 1 month ago

Hello!

I am interested in this. Would you please assign me this task?

harshdoesdev commented 1 month ago

Hi @oyerohabib, Iā€™m assigning this task to @a-wishie so you can focus on the Docsite. @a-wishie, feel free to join our Discord channel if you need any help: https://discord.gg/wrjZmUrm. Thanks a lot for contributing to Shuru. Happy coding!

oyerohabib commented 1 month ago

Hi @harshdoesdev. Alright, this is duly noted.

a-wishie commented 1 month ago

Acknowledged

On Thu, Oct 3, 2024, 2:02 PM Harsh Singh @.***> wrote:

Assigned #7 https://github.com/harshdoesdev/shuru/issues/7 to @a-wishie https://github.com/a-wishie.

ā€” Reply to this email directly, view it on GitHub https://github.com/harshdoesdev/shuru/issues/7#event-14500700689, or unsubscribe https://github.com/notifications/unsubscribe-auth/BESGJEVSBABK6NTYYHOTS6LZZT6I5AVCNFSM6AAAAABPG7WZNWVHI2DSMVQWIX3LMV45UABCJFZXG5LFIV3GK3TUJZXXI2LGNFRWC5DJN5XDWMJUGUYDANZQGA3DQOI . You are receiving this because you were assigned.Message ID: @.***>