docs: Added Markdown files for Documentation #378

hasnainmakada-99 · 2023-12-12T07:28:05Z

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)

My code follows the code style of this project.
My change requires changes to the documentation.
I have updated the documentation accordingly.
This PR does not contain plagiarized content.
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.

… users

vercel · 2023-12-12T07:28:09Z

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	Apr 27, 2024 4:29pm

coderabbitai · 2023-12-12T07:28:11Z

Important

Auto Review Skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Walkthrough

The recent updates to the Drifty project documentation include expanded FAQs, enhanced installation instructions for the Drifty GUI and CLI, and a refreshed Quickstart guide. These changes aim to provide users with a more comprehensive understanding and easier onboarding experience.

Changes

File Path	Change Summary
`.../docs/Faq.md`	Expanded the FAQ section with Q&As related to the "Drifty" project.
`.../docs/Getting-Started.md`	Updated installation instructions for Drifty GUI and CLI on various OS.
`.../docs/Quickstart.md`	Updated the Quickstart guide with new instructions and information.

Related issues

[FEATURE] Add docs for the Website #273: The enhancements to the README and documentation sections such as Quickstart, Getting Started, and FAQ align with the objectives of creating comprehensive documentation for Drifty.

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

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai help to get help.

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

CodeRabbit Configration 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.

github-actions

Yeah! You did it 🎉 Now, Relax 😉, Grab a drink ☕, and wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀. Thank You 😃!

Meanwhile you can also discuss about the project in our Discord Server 😀

coderabbitai

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits

Files that changed from the base of the PR and between 80b31fa and 52ca30a.

Files selected for processing (3)

Website/app/docs/Faq.md (1 hunks)
Website/app/docs/Getting-Started.md (1 hunks)
Website/app/docs/Quickstart.md (1 hunks)

Files skipped from review due to trivial changes (3)

Website/app/docs/Faq.md
Website/app/docs/Getting-Started.md
Website/app/docs/Quickstart.md

SaptarshiSarkar12 · 2023-12-12T07:45:41Z

@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 · 2023-12-12T07:59:24Z

@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 · 2023-12-23T04:33:38Z

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

hasnainmakada-99 · 2023-12-24T16:36:44Z

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 · 2023-12-24T18:12:53Z

It's okay @hasnainmakada-99. No problem 😄.
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 😃.

hasnainmakada-99 · 2023-12-25T06:01:41Z

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

Changed parallel to multhreaded Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

SaptarshiSarkar12 · 2024-02-09T14:37:59Z

@hasnainmakada-99 Please make the requested changes 😃.

hasnainmakada-99 · 2024-02-14T03:09:26Z

Sure @SaptarshiSarkar12

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

SaptarshiSarkar12 · 2024-03-02T18:46:22Z

@hasnainmakada-99 Please make the requested changes 😄.

hasnainmakada-99 · 2024-03-02T19:54:18Z

@hasnainmakada-99 Please make the requested changes 😄.

Sure @saptarshisarkar currently having a lot of academic pressure so cant cope up with the timings

SaptarshiSarkar12 · 2024-03-03T03:21:12Z

@hasnainmakada-99 Okay. Take your time 😃.

SaptarshiSarkar12 · 2024-04-03T11:47:28Z

@hasnainmakada-99 Are you free this week? Will you be able to complete the task 😁?

SaptarshiSarkar12 · 2024-04-13T09:45:10Z

@hasnainmakada-99 Are you free this week? Will you be able to complete the task 😁?

@hasnainmakada-99 Please reply.

hasnainmakada-99 · 2024-04-18T05:24:02Z

Hey @SaptarshiSarkar12 so sorry for late replying, as I am so much caught up with my exams I will not be solve this issue, so sorry once again

SaptarshiSarkar12 · 2024-04-18T05:31:48Z

@hasnainmakada-99 It's fine 😄. So, can I complete the few changes left to be done? And once done, can I merge it?

hasnainmakada-99 · 2024-04-18T05:34:48Z

Yes yes absolutely @SaptarshiSarkar12

SaptarshiSarkar12 · 2024-04-18T05:43:30Z

@hasnainmakada-99 Thank you 😄.

hasnainmakada-99 added 5 commits November 28, 2023 11:33

[add]: docs/Quickstart guide to get the user started

d4eea1d

[add]: Getting-Started.md to help users install drifty on various OS

4d7c042

[add]: Drifty Demo video

cd7abfa

[add]: Dirfty Explanations

61ae360

[add]: FAQ Docs for better troubleshooting of the project for the end…

52ca30a

… users

github-actions bot added documentation 📝 Issues/Pull Requests regarding documentation Website 🌐 Issues/Pull Requests regarding Website labels Dec 12, 2023

github-actions bot reviewed Dec 12, 2023

View reviewed changes

vercel bot deployed to Preview December 12, 2023 07:29 View deployment

coderabbitai bot reviewed Dec 12, 2023

View reviewed changes

SaptarshiSarkar12 marked this pull request as draft December 12, 2023 07:41

Merge branch 'master' into master

0faf709

vercel bot deployed to Preview December 12, 2023 07:44 View deployment

hasnainmakada-99 added 2 commits December 12, 2023 13:19

[fix]: Linter errors in Quickstart.md

783f061

Merge branch 'master' of https://github.com/hasnainmakada-99/Drifty

361e1da

vercel bot deployed to Preview December 12, 2023 07:50 View deployment

SaptarshiSarkar12 changed the title ~~Add: Docs to get featured on the website (Still needs to be updated)~~ feat: Added Docs to get featured on the website Dec 12, 2023

SaptarshiSarkar12 added the feature ✨ New feature request or addition label Dec 12, 2023

[fix]: linters on line 17 of quickstart.md

f7b8e21

vercel bot deployed to Preview December 12, 2023 08:15 View deployment

Merge branch 'master' into master

b740738

vercel bot deployed to Preview December 12, 2023 13:46 View deployment

Update: Website/app/docs/Quickstart.md

343a125

Changed parallel to multhreaded Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

vercel bot deployed to Preview January 26, 2024 02:41 View deployment

hasnainmakada-99 and others added 2 commits January 28, 2024 14:03

Fixed Typo

173f196

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

Fixed Typos by Saptershi

6ca9b95

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

vercel bot deployed to Preview January 28, 2024 08:34 View deployment

Merge branch 'master' into master

2d481a7

vercel bot deployed to Preview February 13, 2024 16:48 View deployment

docs: Updated Installation Video in Quickstart

becf18b

vercel bot deployed to Preview February 13, 2024 17:05 View deployment

hasnainmakada-99 and others added 3 commits February 16, 2024 23:53

Update Website/app/docs/Contribution.md

81fa019

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

Update Website/app/docs/Contribution.md

6baba37

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

Update Website/app/docs/Contribution.md

7d4a320

Co-authored-by: Saptarshi Sarkar <saptarshi.programmer@gmail.com>

vercel bot deployed to Preview February 16, 2024 18:25 View deployment

Merge branch 'master' into master

2b20e52

vercel bot deployed to Preview April 18, 2024 05:44 View deployment

Merge branch 'master' into master

e46b4d9

vercel bot deployed to Preview April 27, 2024 16:29 View deployment

SaptarshiSarkar12 changed the title ~~feat: Added Docs to get featured on the website~~ feat: Added Markdown files for Documentation May 13, 2024

SaptarshiSarkar12 changed the title ~~feat: Added Markdown files for Documentation~~ docs: Added Markdown files for Documentation May 13, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Added Markdown files for Documentation #378

docs: Added Markdown files for Documentation #378

hasnainmakada-99 commented Dec 12, 2023 •

edited by SaptarshiSarkar12

vercel bot commented Dec 12, 2023 •

edited

coderabbitai bot commented Dec 12, 2023 •

edited

Auto Review Skipped

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (`.coderabbit.yaml`)

Documentation and Community

github-actions bot left a comment

coderabbitai bot left a comment

SaptarshiSarkar12 commented Dec 12, 2023 •

edited

SaptarshiSarkar12 commented Dec 12, 2023

SaptarshiSarkar12 commented Dec 23, 2023

hasnainmakada-99 commented Dec 24, 2023

SaptarshiSarkar12 commented Dec 24, 2023

hasnainmakada-99 commented Dec 25, 2023

SaptarshiSarkar12 commented Feb 9, 2024

hasnainmakada-99 commented Feb 14, 2024

SaptarshiSarkar12 commented Mar 2, 2024

hasnainmakada-99 commented Mar 2, 2024

SaptarshiSarkar12 commented Mar 3, 2024

SaptarshiSarkar12 commented Apr 3, 2024

SaptarshiSarkar12 commented Apr 13, 2024

hasnainmakada-99 commented Apr 18, 2024

SaptarshiSarkar12 commented Apr 18, 2024

hasnainmakada-99 commented Apr 18, 2024

SaptarshiSarkar12 commented Apr 18, 2024

docs: Added Markdown files for Documentation #378

Are you sure you want to change the base?

docs: Added Markdown files for Documentation #378

Conversation

hasnainmakada-99 commented Dec 12, 2023 • edited by SaptarshiSarkar12

Changes proposed

Check List (Check all the applicable boxes)

Screenshots

Note to reviewers

Summary by CodeRabbit

vercel bot commented Dec 12, 2023 • edited

coderabbitai bot commented Dec 12, 2023 • edited

Auto Review Skipped

Walkthrough

Changes

Related issues

Poem

Chat

CodeRabbit Commands (invoked as PR comments)

CodeRabbit Configration File (.coderabbit.yaml)

Documentation and Community

github-actions bot left a comment

Choose a reason for hiding this comment

Yeah! You did it 🎉 Now, Relax 😉, Grab a drink ☕, and wait for the maintainers to check your contributions. Meanwhile, you can discuss on other issues and solve them 😀. Thank You 😃!

coderabbitai bot left a comment

Choose a reason for hiding this comment

SaptarshiSarkar12 commented Dec 12, 2023 • edited

SaptarshiSarkar12 commented Dec 12, 2023

SaptarshiSarkar12 commented Dec 23, 2023

hasnainmakada-99 commented Dec 24, 2023

SaptarshiSarkar12 commented Dec 24, 2023

hasnainmakada-99 commented Dec 25, 2023

SaptarshiSarkar12 commented Feb 9, 2024

hasnainmakada-99 commented Feb 14, 2024

SaptarshiSarkar12 commented Mar 2, 2024

hasnainmakada-99 commented Mar 2, 2024

SaptarshiSarkar12 commented Mar 3, 2024

SaptarshiSarkar12 commented Apr 3, 2024

SaptarshiSarkar12 commented Apr 13, 2024

hasnainmakada-99 commented Apr 18, 2024

SaptarshiSarkar12 commented Apr 18, 2024

hasnainmakada-99 commented Apr 18, 2024

SaptarshiSarkar12 commented Apr 18, 2024

hasnainmakada-99 commented Dec 12, 2023 •

edited by SaptarshiSarkar12

vercel bot commented Dec 12, 2023 •

edited

coderabbitai bot commented Dec 12, 2023 •

edited

CodeRabbit Configration File (`.coderabbit.yaml`)

SaptarshiSarkar12 commented Dec 12, 2023 •

edited