docs: Added Markdown files for Documentation

[hasnainmakada-99]

Fixes #273

Changes proposed

Hey, @SaptarshiSarkar12 I've currently added FAQ, getting started and Quickstart guide, I will add more docs related to the aspects mentioned in issue #273, I am currently raising this PR just to break the ICE of this Stale ISSUE, Hope you'll understand it. More changes will be pushed and reviewing will be needed

Check List (Check all the applicable boxes)

• [x] My code follows the code style of this project.
• [x] My change requires changes to the documentation.
• [x] I have updated the documentation accordingly.
• [x] This PR does not contain plagiarized content.
• [x] The title of my pull request is a short description of the requested changes.

Screenshots

NaN

Note to reviewers

NaN

Summary by CodeRabbit

• Documentation
  • Expanded the FAQ section with new entries concerning the "Drifty" project.
  • Updated the Getting Started guide with comprehensive installation instructions for Drifty GUI and CLI.
  • Enhanced the Quickstart guide with updated step-by-step instructions.

[vercel[bot]]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
drifty	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Aug 11, 2024 7:01pm

[coderabbitai[bot]]

Walkthrough

The recent updates to the Drifty project documentation significantly enhance the user and contributor experience. Key additions include a comprehensive FAQ, improved installation instructions for both GUI and CLI, and a Quickstart guide. These changes are designed to streamline navigation and utilization, ensuring that users can easily find the information they need for effective engagement with the project.

Changes

File Path	Change Summary
.../docs/Faq.md	Added a comprehensive FAQ section addressing common user inquiries.
.../docs/Getting-Started.md	Enhanced installation instructions for Drifty GUI and CLI across platforms.
.../docs/Quickstart.md	Introduced a new guide for quick setup and installation of Drifty.
.../docs/Contributing.md	Created a file outlining community contribution guidelines.
.../docs/Development/*.md	Added multiple files detailing project architecture, build processes, and Docker instructions.
.../docs/Usage/drifty-cli/*.md	Introduced detailed documentation for Drifty CLI features and functionalities.
.../docs/Usage/drifty-gui/*.md	Added guides for effectively using the Drifty GUI, including download processes.

Assessment against linked issues

Objective	Addressed	Explanation
Documentation improvements (Issue #273)	✅
Add sections for Quickstart, Getting Started, and FAQ	✅
Provide troubleshooting information	❓	FAQ addresses some issues, but explicit troubleshooting section is not present.
Include contribution guidelines	✅

Poem

In the burrow of code, I hop and leap,
Through docs and guides, a promise to keep.
With each commit, the knowledge tree grows,
Drifty's secrets, the CodeRabbit knows. 🐇💻🌳

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[SaptarshiSarkar12]

@hasnainmakada-99 Please add one blank line after ## Main Features of Drifty (line 7 of Quickstart.md file) and ## A simple demo on how to get started with the GUI of Drifty (line 16 of Quickstart.md file) to fix the linter errors.

[SaptarshiSarkar12]

@hasnainmakada-99 I am sorry. I mistakenly wrote the heading (A simple demo on how to get started with the GUI of Drifty) as line 16 of Quickstart.md file. It is present in line number 17 of that file. Please add a line break after any heading.

[SaptarshiSarkar12]

@hasnainmakada-99 What is the progress of this PR?

[hasnainmakada-99]

Hey @SaptarshiSarkar12, Sorry for the late reply actually I was gone out of town as my exams just got over, So I would like to ask you that so far we I have done the FAQ, Getting Started and Quick Start, so do we need any further guides to make for this project

[SaptarshiSarkar12]

It's okay @hasnainmakada-99. No problem :smile:. We need to add Contributing and Troubleshooting pages. I can help you with the Contributing page which will describe what is the use of each labels in issues, use of GitHub Projects as our Roadmap, etc. and Troubleshooting which will include common problems faced while installing or using the application. Some more pages can be added by me later on - I'll think on this once you make everything ready from your end. @hasnainmakada-99 Let me know if anything else you think can be added :smiley:.

[hasnainmakada-99]

Hey @SaptarshiSarkar12 , We can start with the contributing doc right now WDYS? once the contributing docs will be completed then we'll start with the troubleshooting docs

[SaptarshiSarkar12]

Yeah, we can start with that. Agreed @hasnainmakada-99 :+1:.

[hasnainmakada-99]

Alright, Then tell me whatt should I include inside the contribution guide @SaptarshiSarkar12

[SaptarshiSarkar12]

@hasnainmakada-99 The Contributing page should contain :point_down:

• A link to the Contributing Guidelines.
• Project structure (like which directory contains which type of files) [You can find an example here]
• A brief description of what each issue and PR labels mean (You can keep the heading as Labels and sub-headings as In Issues and In Pull Requests)
• A guide on how to Build Drifty executable using two ways (Local Development and Using Docker Compose)

@hasnainmakada-99 Anything else to add? Please let me know. I'm out of ideas now :laughing:

[hasnainmakada-99]

@hasnainmakada-99 The Contributing page should contain 👇

• A link to the Contributing Guidelines.
• Project structure (like which directory contains which type of files) [You can find an example here]
• A brief description of what each issue and PR labels mean (You can keep the heading as Labels and sub-headings as In Issues and In Pull Requests)
• A guide on how to Build Drifty executable using two ways (Local Development and Using Docker Compose)

@hasnainmakada-99 Anything else to add? Please let me know. I'm out of ideas now 😆

No worries @SaptarshiSarkar12, I'll start working on it ASAP

[SaptarshiSarkar12]

Okay @hasnainmakada-99 :smile:.

[hasnainmakada-99]

Hey @SaptarshiSarkar12, I'm Halfway done with the contribution docs

[SaptarshiSarkar12]

Okay @hasnainmakada-99. That's great :+1:. Please consider updating your code with the master branch of the original repo :upside_down_face:.

[hasnainmakada-99]

Done @SaptarshiSarkar12

[SaptarshiSarkar12]

Great :+1: @hasnainmakada-99

[SaptarshiSarkar12]

@hasnainmakada-99 Now, would you start with the troubleshooting docs page?

[SaptarshiSarkar12]

@hasnainmakada-99 Can you please create the feature to render markdown docs pages on the website, before making the Troubleshooting docs? I want to see how it would look like :smile:.

[hasnainmakada-99]

@hasnainmakada-99 Can you please create the feature to render markdown docs pages on the website, before making the Troubleshooting docs? I want to see how it would look like 😄.

Ahh, Actually I am not familiar with implementing that feature @SaptarshiSarkar12, So I may not be able to help you with that

[SaptarshiSarkar12]

I guess you haven't understood my words. I was asking you to do the rest of the work of this issue, other than creating md files.

[hasnainmakada-99]

I guess you haven't understood my words. I was asking you to do the rest of the work of this issue, other than creating md files.

Yes @SaptarshiSarkar12, I don't know how to do that, so I can't help you with that, but for now I can work on creating the MD files required to render

[SaptarshiSarkar12]

Okay. You can do that. But, the issue was supposed to make the rendering of those files. Still, are you going to learn that? I have already prepared a protoype of the docs https://github.com/SaptarshiSarkar12/Drifty/tree/preview-docs

[hasnainmakada-99]

No @SaptarshiSarkar12, I might not be a good fit for designing that, honestly saying because it will be a waste of time for us, So you should look for someone else to work on the rendering part and I can help you with the docs

[SaptarshiSarkar12]

Okay @hasnainmakada-99

[SaptarshiSarkar12]

@hasnainmakada-99 Then, let's start with the Troubleshooting docs.

[hasnainmakada-99]

@SaptarshiSarkar12 So sorry for not updating, actually vivas are going that's why, hope you'll understand

[hasnainmakada-99]

Currently the contribution docs are still in the queue, So i'll complete it by today ASAP @SaptarshiSarkar12

[SaptarshiSarkar12]

@SaptarshiSarkar12 So sorry for not updating, actually vivas are going that's why, hope you'll understand

It's fine @hasnainmakada-99. No problem :smile:.

Currently the contribution docs are still in the queue, So i'll complete it by today ASAP @SaptarshiSarkar12

That's great :+1:. Also, if you have any suggestion on more sections in the docs, please let me know. Suggestions are warmly welcomed :grin:.

[sonarqubecloud[bot]]

Quality Gate passed

Kudos, no new issues were introduced!

0 New issues
0 Security Hotspots
No data about Coverage
No data about Duplication

See analysis details on SonarCloud