[FEATURE] Add docs for the Website

[SaptarshiSarkar12]

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.

[sathvik-ng-07]

Hi SaptarshiSarkar12,

I'm interested in working on this issue. I've reviewed the problem and your proposed solution, and I'd like to contribute to improving the documentation for Drifty as described.

Here's what I plan to do:

• Create separate Markdown files for each documentation section (Quickstart, Getting Started, Contributing, FAQ, and Troubleshooting).
• Populate these files with clear and detailed content, including examples and code snippets where necessary.
• Update the main README file to link to the newly created documentation files.
• Test the changes locally to ensure they work as expected.
• Open a pull request (PR) once the changes are ready for review.

Please let me know if you have any specific requirements, guidelines, or additional information I should be aware of before I start working on this. And also let me know if i can submit PR on the master branch itself or some other branch . I'm excited to contribute to the project and help improve its documentation.

Thank you!
Sathvik N G

[SaptarshiSarkar12]

Thank you @sathvik-ng-07 for your interest in this issue!
Yes, I agree with your plan. Looks good to me. 👍
You need to open the PR to the master branch (the default branch). Please do not open any PR against other branches.
I am assigning you with the task. You can start working on it.

[SaptarshiSarkar12]

@sathvik-ng-07 no longer wants to work on it.

If anyone else wants to work on this issue, please comment below and I will assign you with the task.

[chauhansumitdev]

I would like to work on this issue.

[SaptarshiSarkar12]

I would like to work on this issue.

Thank you for your interest in this issue!
I am assigning you with the task.

[markandey1414]

Hello @SaptarshiSarkar12 , I would like to work on this issue and resolve it.

[SaptarshiSarkar12]

@markandey1414 Yes, you can work on this issue. Assigning the task to you.

You can discuss this issue in our Discord server.

[Neel-07]

hello @SaptarshiSarkar12, can you assign this issue to me i would like to work on this issue.

[SaptarshiSarkar12]

If @markandey1414 no longer wants to work on this issue, then, I can assign you (@Neel-07 ). Let's wait for his (@markandey1414 ) reply.

[markandey1414]

Yes @SaptarshiSarkar12 I'm working on it. Thanks for assigning me this.

[SaptarshiSarkar12]

Okay @markandey1414.

[markandey1414]

@SaptarshiSarkar12 permission to access the repo is denied, not able to issue pr

[SaptarshiSarkar12]

@markandey1414 Why? Can you please show the exact error?

[goody-dev]

Yes, @SaptarshiSarkar12. That's fine.

[SaptarshiSarkar12]

Okay. Thank you @goody-dev 👍.

[goody-dev]

Pls inform me when I can start working on it, @SaptarshiSarkar12. It seems like work is still ongoing on the MD files.

[SaptarshiSarkar12]

@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]

@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]

@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]

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

[SaptarshiSarkar12]

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

[goody-dev]

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

[SaptarshiSarkar12]

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

[SaptarshiSarkar12]

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]

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 <#273 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AYN6C7YP6RCGMVJ77GS2B43Y5K6WDAVCNFSM6AAAAAA5EBHGRCVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDANJUGEZTGMJSGI> . You are receiving this because you were mentioned.Message ID: ***@***.***>

[SaptarshiSarkar12]

@goody-dev Okay. Thank you 👍🏻.

[abhilashreddysh]

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

[SaptarshiSarkar12]

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