[FEATURE] Add docs for the Website

SaptarshiSarkar12 commented 1 year ago

Is your feature request related to a problem? Please describe.

The README file currently lacks examples and use cases for both Drifty CLI and GUI. It also does not mention the custom issue labels that the project uses. Before testing their changes, the contributors need to run some commands. The addition of Dockerfiles to this project via #218 will require some notes and advices, but the README file is already too crowded and lengthy.

Describe the solution you'd like.

I would like to have a docs section for Drifty with sections like - Quickstart, Getting Started, Contributing, FAQ and Troubleshooting.

Quickstart: A brief introduction to the main features of Drifty, with a simple example to get users up and running in minutes.
Getting Started: A more detailed guide on how to install, configure, and use Drifty, with explanations of the core components and options.
Contributing: A section for developers who want to help make Drifty better, with instructions on how to set up a development environment, submit pull requests, and report bugs and new ideas.
FAQ: A collection of common questions and answers about Drifty, covering topics such as compatibility, performance, security, and customization.
Troubleshooting: This subsection helps to resolve common issues and errors that users may encounter while using Drifty and suggests possible solutions and workarounds.

The docs should be in markdown files and will be rendered by next js. You can read more about this here.

If you have any suggestions to add more suggestions, please let me know.

Screenshots

The docs page can have a look like this -

You can see the live version of the docs homepage here.

Additional information

Skills you need to solve this issue - NextJS, TailwindCSS, MD / MDX in Nextjs. Those who wish to work on this issue, please leave a comment below and I will assign you with the task.

SaptarshiSarkar12 commented 10 months ago

@goody-dev You can start working on tha feature. For now, you can create test MD files which will get rendered. Later on, when @hasnainmakada-99's PR gets merged, I'll update your MD files with his. Is that okay for you 🙂?

goody-dev commented 10 months ago

@goody-dev You can start working on tha feature. For now, you can create test MD files which will get rendered. Later on, when @hasnainmakada-99's PR gets merged, I'll update your MD files with his. Is that okay for you 🙂?

That's alright.

goody-dev commented 10 months ago

@SaptarshiSarkar12, I have been unable to clone the repository to my local machine due to weak internet connection. I would get back to you if I have been able to clone it, and if anyone comes around before then and would to take on it they are free to.

SaptarshiSarkar12 commented 10 months ago

Okay. It's fine. You can take your time :smile: @goody-dev.

SaptarshiSarkar12 commented 10 months ago

@goody-dev Were you able to clone the repo?

goody-dev commented 10 months ago

No, I haven't been able to... And I have cloned another repo in between trying to.

SaptarshiSarkar12 commented 10 months ago

Okay. If you are able to clone it later on, please inform me.

SaptarshiSarkar12 commented 7 months ago

No, I haven't been able to... And I have cloned another repo in between trying to.

@goody-dev Were you able to clone the repo successfully 😄?

goody-dev commented 6 months ago

Sorry, I won't be able to work on it at this time. you can assign others.

On Sun, Apr 14, 2024 at 6:50 PM Saptarshi Sarkar @.***> wrote:

No, I haven't been able to... And I have cloned another repo in between trying to.

@goody-dev https://github.com/goody-dev Were you able to clone the repo successfully 😄?

— Reply to this email directly, view it on GitHub https://github.com/SaptarshiSarkar12/Drifty/issues/273#issuecomment-2054133122, or unsubscribe https://github.com/notifications/unsubscribe-auth/AYN6C7YP6RCGMVJ77GS2B43Y5K6WDAVCNFSM6AAAAAA5EBHGRCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANJUGEZTGMJSGI . You are receiving this because you were mentioned.Message ID: @.***>

SaptarshiSarkar12 commented 6 months ago

@goody-dev Okay. Thank you 👍🏻.

abhilashreddysh commented 5 months ago

@SaptarshiSarkar12 I can work on this. You can assign this issue to me.

SaptarshiSarkar12 commented 5 months ago

@abhilashreddysh Thank you for your interest on this issue, Abhilash :smile:! I am assigning the issue to you.

SaptarshiSarkar12 / Drifty