docs: Added Markdown files for Documentation #378
Conversation
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
WalkthroughThe 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
Assessment against linked issues
Poem
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? TipsChatThere are 3 ways to chat with CodeRabbit:
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)
Additionally, you can add CodeRabbit Configuration File (
|
github-actions
bot
added
documentation 📝
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem 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 😃!
Meanwhile you can also discuss about the project in our Discord Server 😀
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Review Status
Actionable comments generated: 0
Configuration used: CodeRabbit UI
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
|
@hasnainmakada-99 Please add one blank line after ## Main Features of Drifty (line 7 of |
SaptarshiSarkar12
changed the title
|
@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 |
|
@hasnainmakada-99 What is the progress of this PR? |
|
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 |
|
It's okay @hasnainmakada-99. No problem 😄. |
|
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 |
…instructions for setting up the project
❌ Linting errors found!@hasnainmakada-99 Please fix the following errors: |
…nainmakada-99/master
…CLI and GUI before building executables
There was a problem hiding this comment.
Actionable comments posted: 8
Outside diff range, codebase verification and nitpick comments (21)
Website/app/docs/Faq.md (4)
3-3: Consider adding a comma here.A comma would improve readability.
- 1. **Why does Drifty GUI not open in my Windows machine?** + 1. **Why does Drifty GUI not open in my Windows machine?**Tools
LanguageTool
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
18-21: Consider making technology names bold.Making "Java", "JavaFX", "Docker", and "Next.js" bold improves readability.
- - **Java** - for the backend part of the application - - **JavaFX** - for the GUI part of the application - - **Docker** - for containerizing Drifty to add support for more platforms and help in faster local development - - **Next.js** - for building the official [Website of Drifty](https://saptarshisarkar12.github.io/Drifty/)
33-33: Update the link to point directly to the relevant section.The link should point to the specific section for Docker usage.
- ➡️ Currently, Beta features are available only through Docker images. You can check the official [GitHub Docs for Drifty](https://github.com/SaptarshiSarkar12/Drifty/blob/master/README.md). + ➡️ Currently, Beta features are available only through Docker images. You can check the official [GitHub Docs for Drifty](https://github.com/SaptarshiSarkar12/Drifty?tab=readme-ov-file#using-drifty-application-via-docker-).
35-36: Clarify the FAQ entry title.The title should be more descriptive.
- 8. **In-detail explanations of Drifty needed?** + 8. **Do you require any detailed explanations of Drifty?**Website/app/docs/Development/Quickstart.md (5)
1-3: Clarify the purpose of the guide.Consider adding a brief sentence to clarify that this guide is for developers who want to contribute to the project.
- This is a quick start guide to get you up and running with the project for development purposes. + This is a quick start guide to get developers up and running with the project for development purposes.
7-8: Improve the note formatting.The note about Git installation can be formatted using a more standard Markdown note syntax for better readability.
- > [!NOTE] + > **Note:**
40-40: Simplify the wording.Simplify the wording to make it more concise.
- You can start making changes to the code and see the changes reflected in the application. Remember to re-run the project every time you make changes to see the updated output. + Make changes to the code and see them reflected in the application. Re-run the project after each change to see the updated output.Tools
LanguageTool
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...rifty GUI application. 3. You can start making changes to the code and see the changes reflected ...(MAKE_CHANGES)
44-44: Use a more formal verb.Consider using a more formal verb for clarity.
- and inspect variables to identify and fix issues. + and inspect variables to identify and resolve issues.Tools
LanguageTool
[style] ~44-~44: Consider using a different verb for a more formal wording.
Context: ...e and inspect variables to identify and fix issues. ## Drifty Website Development ...(FIX_RESOLVE)
71-71: Simplify the wording.Simplify the wording to make it more concise.
- You can make changes to the website code from your IDE, and the changes will be reflected in real-time in the browser. + Make changes to the website code from your IDE, and see them reflected in real-time in the browser.Tools
LanguageTool
[style] ~71-~71: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ocalhost:3000` in your browser. You can make changes to the website code from your IDE, and the...(MAKE_CHANGES)
Website/app/docs/Contributing.md (2)
1-1: Clarify the title.Consider clarifying the title to specify that this is a contributing guide for the Drifty project.
- # Contributing to Drifty + # Contributing to the Drifty Project
9-9: Improve the code of conduct description.Consider breaking the sentence into two for better readability.
- We have a [Code of Conduct](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CODE_OF_CONDUCT.md) that all contributors must follow. This code of conduct outlines our expectations for participants within the project and also steps to report unacceptable behavior. + We have a [Code of Conduct](https://github.com/SaptarshiSarkar12/Drifty/blob/master/CODE_OF_CONDUCT.md) that all contributors must follow. This code of conduct outlines our expectations for participants within the project. It also includes steps to report unacceptable behavior.Website/app/docs/Quickstart.md (1)
5-5: Improve the sentence structure.Consider breaking the sentence into two for better readability.
- Go to the official website of Drifty and then click on the download button, it will redirect you to the download page. + Go to the official website of Drifty and click on the download button. It will redirect you to the download page.Website/app/docs/Development/Building-Executables.md (4)
37-37: Add missing article "the".The sentence "the GraalVM metadata will be generated in
src/main/resources/META-INF/native-imagedirectory" is missing the article "the" before "GraalVM metadata".- the GraalVM metadata will be generated in `src/main/resources/META-INF/native-image` directory + the GraalVM metadata will be generated in the `src/main/resources/META-INF/native-image` directoryTools
LanguageTool
[uncategorized] ~37-~37: You might be missing the article “the” here.
Context: ...e GraalVM metadata will be generated in `src/main/resources/META-INF/native-image...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
52-52: Add missing article "the".The sentence "If the command is not recognized, add GraalVM
bindirectory to the system path" is missing the article "the" before "GraalVM".- add GraalVM `bin` directory to the system path + add the GraalVM `bin` directory to the system pathTools
LanguageTool
[uncategorized] ~52-~52: You might be missing the article “the” here.
Context: ...> If the command is not recognized, add GraalVMbindirectory to the system path. > `...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
56-56: Add missing comma.The sentence "The below environment variable must be set pointing to the GraalVM installation directory" is missing a comma after "set".
- The below environment variable must be set pointing to the GraalVM installation directory + The below environment variable must be set, pointing to the GraalVM installation directoryTools
LanguageTool
[uncategorized] ~56-~56: Possible missing comma found.
Context: ... The below environment variable must be set pointing to the GraalVM installation di...(AI_HYDRA_LEO_MISSING_COMMA)
141-141: Remove duplicated word.The word "Docker" is repeated in "Docker Docker".
- [Docker](https://docs.docker.com/get-docker/) + [Docker](https://docs.docker.com/get-docker/)Tools
LanguageTool
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS Docker Build Instructions.md (5)
31-31: Avoid repetition for clarity.The phrase "If you are going to" is repeated. Consider rephrasing to add variety.
- If you are going to build **Drifty GUI** Docker image using your changed source code, then run this command in the directory where the project files are present: + To build the **Drifty GUI** Docker image using your changed source code, run this command in the directory where the project files are present:Tools
LanguageTool
[style] ~31-~31: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...h docker compose build gui ``` - If you are going to use the pre-built Drifty GUI Docker...(REP_GOING_TO_VB)
70-70: Add missing determiner.The phrase "If you are not running at least macOS version 13 (Ventura)" is missing the determiner "the".
- If you are not running at **_least macOS version 13 (Ventura)_**, then refer to [**this article**](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) to get the instructions for **statically assigning your IP address**. + If you are not running at **_the least macOS version 13 (Ventura)_**, then refer to [**this article**](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) to get the instructions for **statically assigning your IP address**.Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
72-72: Add hyphen for clarity.Consider adding a hyphen in "top left corner" for clarity.
- by clicking on the Apple logo in the top left corner of your screen. + by clicking on the Apple logo in the top-left corner of your screen.Tools
LanguageTool
[uncategorized] ~72-~72: Consider adding a hyphen.
Context: ...sby clicking on the Apple logo in the top left corner of your screen. - Click onNetw...(TOP_LEFT_CORNER)
104-104: Avoid repetition for clarity.The phrase "Remember to change the tag to the version/branch you want to use" is repeated. Consider rephrasing to add variety.
- Remember to change the tag to the version/branch you want to use. + Ensure to update the tag to the desired version/branch.Tools
LanguageTool
[style] ~104-~104: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...hange the tag to the version/branch you want to use. - If you want to run the **docker ...(REP_WANT_TO_VB)
105-105: Avoid repetition for clarity.The phrase "If you want to run" is repeated. Consider rephrasing to add variety.
- If you want to run the **docker image built from your changed source code** (by using `docker compose`), then run these commands: + To run the **docker image built from your changed source code** (using `docker compose`), execute the following commands:Tools
LanguageTool
[style] ~105-~105: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ersion/branch you want to use. - If you want to run the **docker image built from your ...(REP_WANT_TO_VB)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (10)
- .github/linters/.markdown-lint.yml (1 hunks)
- .idea/misc.xml (1 hunks)
- Website/app/docs/Contributing.md (1 hunks)
- Website/app/docs/Development/Architecture.md (1 hunks)
- Website/app/docs/Development/Building-Executables.md (1 hunks)
- Website/app/docs/Development/Quickstart.md (1 hunks)
- Website/app/docs/Development/macOS Docker Build Instructions.md (1 hunks)
- Website/app/docs/Faq.md (1 hunks)
- Website/app/docs/Overview.md (1 hunks)
- Website/app/docs/Quickstart.md (1 hunks)
Files skipped from review due to trivial changes (2)
- .idea/misc.xml
- Website/app/docs/Overview.md
Additional context used
LanguageTool
Website/app/docs/Faq.md
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
Website/app/docs/Development/Architecture.md
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ... the following directories: -.github: Contains the GitHub Actions workflows, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...and other GitHub-specific files. -CLI: Maven child module containing the sourc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... source code for the Drifty CLI. -GUI: Maven child module containing the sourc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...source code for the Drifty GUI. -Core: Maven child module containing the share...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ode between the CLI and GUI. -Website: Contains the source code for the Drifty...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...site (A Next.js application). -config: Contains the configuration files for bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...e installers and executables. -Docker: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...ication in a Docker container. -dev: Contains the Dockerfiles to build and r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...er for development purposes. -CLI: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...er for development purposes. -GUI: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...or development purposes. -commons: Contains the Dockerfiles for the base i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ifty CLI and GUI Dockerfiles. -prod: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...ner for production purposes. -CLI: Contains the Dockerfile to build the Do...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...r the Drifty CLI executable. -GUI: Contains the Dockerfile to build the Do...(UNLIKELY_OPENING_PUNCTUATION)
Website/app/docs/Development/Quickstart.md
[uncategorized] ~39-~39: You might be missing the article “the” here.
Context: ... - Open theDrifty_GUIjava class inGUI/src/main/java/maindirectory and cl...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...rifty GUI application. 3. You can start making changes to the code and see the changes reflected ...(MAKE_CHANGES)
[style] ~44-~44: Consider using a different verb for a more formal wording.
Context: ...e and inspect variables to identify and fix issues. ## Drifty Website Development ...(FIX_RESOLVE)
[style] ~71-~71: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ocalhost:3000` in your browser. You can make changes to the website code from your IDE, and the...(MAKE_CHANGES)
Website/app/docs/Contributing.md
[uncategorized] ~37-~37: Possible missing comma found.
Context: ...rst, describing the changes you want to make and discuss them with the maintainers. ...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~68-~68: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...d in the project. You can work on the todo tasks by creating the issue (if not a...(TO_DO_HYPHEN)
Website/app/docs/Quickstart.md
[uncategorized] ~17-~17: You might be missing the article “a” here.
Context: ...5-61d68a69a313) - If you are using Mac, click on the download button with the ...(AI_EN_LECTOR_MISSING_DETERMINER_A)
[style] ~26-~26: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...677f08-de5f-4ade-9414-881abe82edc4) - If you are using Mac, click on the downloa...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~26-~26: You might be missing the article “a” here.
Context: ...9414-881abe82edc4) - If you are using Mac, click on the download button with the ...(AI_EN_LECTOR_MISSING_DETERMINER_A)
Website/app/docs/Development/Building-Executables.md
[uncategorized] ~37-~37: You might be missing the article “the” here.
Context: ...e GraalVM metadata will be generated in `src/main/resources/META-INF/native-image...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~52-~52: You might be missing the article “the” here.
Context: ...> If the command is not recognized, add GraalVMbindirectory to the system path. > `...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ... The below environment variable must be set pointing to the GraalVM installation di...(AI_HYDRA_LEO_MISSING_COMMA)
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS Docker Build Instructions.md
[style] ~31-~31: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...h docker compose build gui ``` - If you are going to use the pre-built Drifty GUI Docker...(REP_GOING_TO_VB)
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
[uncategorized] ~72-~72: Consider adding a hyphen.
Context: ...sby clicking on the Apple logo in the top left corner of your screen. - Click onNetw...(TOP_LEFT_CORNER)
[style] ~104-~104: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...hange the tag to the version/branch you want to use. - If you want to run the **docker ...(REP_WANT_TO_VB)
[style] ~105-~105: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ersion/branch you want to use. - If you want to run the **docker image built from your ...(REP_WANT_TO_VB)
Markdownlint
Website/app/docs/Quickstart.md
11-11: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
14-14: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
17-17: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
Additional comments not posted (7)
.github/linters/.markdown-lint.yml (1)
10-11: LGTM! The change to MD024 improves document structure flexibility.The modification to allow multiple headers with the same content under different nesting levels is appropriate.
Website/app/docs/Development/Architecture.md (2)
24-33: LGTM! The Technologies Used section is comprehensive and well-documented.The description of the technologies used in the Drifty project is clear and complete.
7-20: Remove unnecessary punctuation marks.The punctuation marks before the directory descriptions are unnecessary.
- - `.github`: Contains the GitHub Actions workflows, issue and pull request templates, linter configuration files, and other GitHub-specific files. - - `CLI`: Maven child module containing the source code for the Drifty CLI. - - `GUI`: Maven child module containing the source code for the Drifty GUI. - - `Core`: Maven child module containing the shared code between the CLI and GUI. - - `Website`: Contains the source code for the Drifty website (A Next.js application). - - `config`: Contains the configuration files for building the native installers and executables. - - `Docker`: Contains the Dockerfile to build and run the Drifty application in a Docker container. - - `dev`: Contains the Dockerfiles to build and run the Drifty application in a Docker container for development purposes. - - `CLI`: Contains the Dockerfile to build and run the Drifty CLI executable in a Docker container for development purposes. - - `GUI`: Contains the Dockerfile to build and run the Drifty GUI executable in a Docker container for development purposes. - - `commons`: Contains the Dockerfiles for the base images used by the Drifty CLI and GUI Dockerfiles. - - `prod`: Contains the Dockerfile to build and run the Drifty application in a Docker container for production purposes. - - `CLI`: Contains the Dockerfile to build the Docker image for the Drifty CLI executable. - - `GUI`: Contains the Dockerfile to build the Docker image for the Drifty GUI executable. + - `.github` Contains the GitHub Actions workflows, issue and pull request templates, linter configuration files, and other GitHub-specific files. + - `CLI` Maven child module containing the source code for the Drifty CLI. + - `GUI` Maven child module containing the source code for the Drifty GUI. + - `Core` Maven child module containing the shared code between the CLI and GUI. + - `Website` Contains the source code for the Drifty website (A Next.js application). + - `config` Contains the configuration files for building the native installers and executables. + - `Docker` Contains the Dockerfile to build and run the Drifty application in a Docker container. + - `dev` Contains the Dockerfiles to build and run the Drifty application in a Docker container for development purposes. + - `CLI` Contains the Dockerfile to build and run the Drifty CLI executable in a Docker container for development purposes. + - `GUI` Contains the Dockerfile to build and run the Drifty GUI executable in a Docker container for development purposes. + - `commons` Contains the Dockerfiles for the base images used by the Drifty CLI and GUI Dockerfiles. + - `prod` Contains the Dockerfile to build and run the Drifty application in a Docker container for production purposes. + - `CLI` Contains the Dockerfile to build the Docker image for the Drifty CLI executable. + - `GUI` Contains the Dockerfile to build the Docker image for the Drifty GUI executable.Likely invalid or redundant comment.
Tools
LanguageTool
[uncategorized] ~7-~7: Loose punctuation mark.
Context: ... the following directories: -.github: Contains the GitHub Actions workflows, ...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~8-~8: Loose punctuation mark.
Context: ...and other GitHub-specific files. -CLI: Maven child module containing the sourc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~9-~9: Loose punctuation mark.
Context: ... source code for the Drifty CLI. -GUI: Maven child module containing the sourc...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~10-~10: Loose punctuation mark.
Context: ...source code for the Drifty GUI. -Core: Maven child module containing the share...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~11-~11: Loose punctuation mark.
Context: ...ode between the CLI and GUI. -Website: Contains the source code for the Drifty...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~12-~12: Loose punctuation mark.
Context: ...site (A Next.js application). -config: Contains the configuration files for bu...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~13-~13: Loose punctuation mark.
Context: ...e installers and executables. -Docker: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~14-~14: Loose punctuation mark.
Context: ...ication in a Docker container. -dev: Contains the Dockerfiles to build and r...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~15-~15: Loose punctuation mark.
Context: ...er for development purposes. -CLI: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~16-~16: Loose punctuation mark.
Context: ...er for development purposes. -GUI: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~17-~17: Loose punctuation mark.
Context: ...or development purposes. -commons: Contains the Dockerfiles for the base i...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~18-~18: Loose punctuation mark.
Context: ...ifty CLI and GUI Dockerfiles. -prod: Contains the Dockerfile to build and ru...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~19-~19: Loose punctuation mark.
Context: ...ner for production purposes. -CLI: Contains the Dockerfile to build the Do...(UNLIKELY_OPENING_PUNCTUATION)
[uncategorized] ~20-~20: Loose punctuation mark.
Context: ...r the Drifty CLI executable. -GUI: Contains the Dockerfile to build the Do...(UNLIKELY_OPENING_PUNCTUATION)
Website/app/docs/Development/Quickstart.md (1)
13-14: Ensure the repository URL is correct.Verify that the repository URL is correct and accessible.
Verification successful
The repository URL is correct and accessible.
- The repository was successfully cloned using the HTTPS URL.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the repository URL is correct and accessible. # Test: Clone the repository. Expect: Successful clone. git clone git@github.com:SaptarshiSarkar12/Drifty.gitLength of output: 213
Script:
#!/bin/bash # Description: Verify the repository URL is correct and accessible using HTTPS. # Test: Clone the repository using HTTPS. Expect: Successful clone. git clone https://github.com/SaptarshiSarkar12/Drifty.gitLength of output: 2284
Website/app/docs/Development/Building-Executables.md (1)
39-136: LGTM!The instructions for local build are clear and well-structured.
Tools
LanguageTool
[uncategorized] ~52-~52: You might be missing the article “the” here.
Context: ...> If the command is not recognized, add GraalVMbindirectory to the system path. > `...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[uncategorized] ~56-~56: Possible missing comma found.
Context: ... The below environment variable must be set pointing to the GraalVM installation di...(AI_HYDRA_LEO_MISSING_COMMA)
Website/app/docs/Development/macOS Docker Build Instructions.md (2)
5-12: LGTM!The prerequisites are clear and well-structured.
59-80: LGTM!The instructions for manually assigning an IP address are clear and well-structured.
Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
[uncategorized] ~72-~72: Consider adding a hyphen.
Context: ...sby clicking on the Apple logo in the top left corner of your screen. - Click onNetw...(TOP_LEFT_CORNER)
…nainmakada-99/master
There was a problem hiding this comment.
Actionable comments posted: 3
Outside diff range, codebase verification and nitpick comments (3)
Website/app/docs/Faq.md (3)
3-5: Add a comma for clarity.Add a comma after "machine" for better readability.
- ➡️ Your Windows machine must have Microsoft Visual C++ Redistributable installed on your machine. You can download and install it from its [official download page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170) + ➡️ Your Windows machine must have Microsoft Visual C++ Redistributable installed on your machine. You can download and install it from its [official download page](https://learn.microsoft.com/en-us/cpp/windows/latest-supported-vc-redist?view=msvc-170).Tools
LanguageTool
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
15-21: Make technology names bold.Make the names of the technologies bold for better readability.
- ➡️ The technologies that Drifty uses are as follows: - - Java - for the backend part of the application - - JavaFX - for the GUI part of the application - - Docker - for containerizing Drifty to add support for more platforms and help in faster local development - - Next.js - for building the official [Website of Drifty](https://saptarshisarkar12.github.io/Drifty/) + ➡️ The technologies that Drifty uses are as follows: + - **Java** - for the backend part of the application + - **JavaFX** - for the GUI part of the application + - **Docker** - for containerizing Drifty to add support for more platforms and help in faster local development + - **Next.js** - for building the official [Website of Drifty](https://saptarshisarkar12.github.io/Drifty/)
35-36: Add a question mark.Add a question mark at the end of the question for grammatical correctness.
-8. **Do you require any detailed explanations of Drifty?** +8. **Do you require any detailed explanations of Drifty?**Tools
LanguageTool
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- Website/app/docs/Contributing.md (1 hunks)
- Website/app/docs/Development/Building-Executables.md (1 hunks)
- Website/app/docs/Development/Quickstart.md (1 hunks)
- Website/app/docs/Development/macOS Docker Build Instructions.md (1 hunks)
- Website/app/docs/Faq.md (1 hunks)
- Website/app/docs/Quickstart.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- Website/app/docs/Contributing.md
Additional context used
LanguageTool
Website/app/docs/Faq.md
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Website/app/docs/Development/Quickstart.md
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ll start the Drifty GUI application. 3. Make changes to the code and see them reflected in the ...(MAKE_CHANGES)
[style] ~70-~70: Consider shortening or rephrasing this to strengthen your wording.
Context: ...http://localhost:3000` in your browser. Make changes to the website code from your IDE and see ...(MAKE_CHANGES)
Website/app/docs/Quickstart.md
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...677f08-de5f-4ade-9414-881abe82edc4) - If you are using macOS, click on the downl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Website/app/docs/Development/Building-Executables.md
[uncategorized] ~37-~37: You might be missing the article “the” here.
Context: ...e GraalVM metadata will be generated in `src/main/resources/META-INF/native-image...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS Docker Build Instructions.md
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
Additional comments not posted (16)
Website/app/docs/Faq.md (5)
7-9: LGTM!The answer is clear and provides a helpful link.
23-25: LGTM!The answer is clear and provides a helpful link.
31-33: LGTM!The answer is clear and provides a helpful link.
27-29: Fix the typo in the link description.The link description should be "work-in-progress" instead of "work-in-progress".
- ➡️ Automatic updates are not supported yet and are still a [work-in-progress](https://github.com/SaptarshiSarkar12/Drifty/issues/217). To update Drifty, download [the latest version](https://saptarshisarkar12.github.io/Drifty/download) from the official website and install it. + ➡️ Automatic updates are not supported yet and are still a [work-in-progress](https://github.com/SaptarshiSarkar12/Drifty/issues/217). To update Drifty, download [the latest version](https://saptarshisarkar12.github.io/Drifty/download) from the official website and install it.Likely invalid or redundant comment.
11-13: Fix the typo in the link description.The link description should be "watch" instead of "watch button".
- ➡️ You can join our [Discord server](https://discord.com/invite/DeT4jXPfkG) to get updates on this project. You can also watch this repository by clicking on the watch button [here](https://github.com/SaptarshiSarkar12/Drifty) and select notification types to **All Activity** to get all updates on this project. + ➡️ You can join our [Discord server](https://discord.com/invite/DeT4jXPfkG) to get updates on this project. You can also watch this repository by clicking on the watch button [here](https://github.com/SaptarshiSarkar12/Drifty) and select notification types to **All Activity** to get all updates on this project.Likely invalid or redundant comment.
Website/app/docs/Development/Quickstart.md (3)
17-45: LGTM!The section is clear and provides helpful instructions.
Tools
LanguageTool
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ll start the Drifty GUI application. 3. Make changes to the code and see them reflected in the ...(MAKE_CHANGES)
46-75: LGTM!The section is clear and provides helpful instructions.
Tools
LanguageTool
[style] ~70-~70: Consider shortening or rephrasing this to strengthen your wording.
Context: ...http://localhost:3000` in your browser. Make changes to the website code from your IDE and see ...(MAKE_CHANGES)
77-79: LGTM!The section is clear and provides a helpful link.
Website/app/docs/Quickstart.md (1)
28-62: LGTM!The section is clear and provides helpful instructions.
Website/app/docs/Development/Building-Executables.md (3)
39-75: LGTM!The instructions for the local build are clear and detailed.
94-110: LGTM!The instructions for running the Docker image are clear and detailed.
141-141: Fix duplication issue: Remove repeated word "Docker".The word "Docker" is repeated.
- [Docker](https://docs.docker.com/get-docker/) + [Docker](https://docs.docker.com/get-docker/)Likely invalid or redundant comment.
Tools
LanguageTool
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS Docker Build Instructions.md (4)
5-12: LGTM!The prerequisites are clearly listed and detailed.
59-80: LGTM!The steps for manually assigning an IP address are clear and detailed.
Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
94-110: LGTM!The commands to run the Docker image are clear and detailed.
70-70: Fix grammatical issue: Add missing determiner "the".The sentence is missing the determiner "the" before "least".
- If you are not running at **_least macOS version 13 (Ventura)_**, then refer to... + If you are not running at **_the least macOS version 13 (Ventura)_**, then refer to...Likely invalid or redundant comment.
Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
An overview of both the Drifty CLI commands and a detailed description of the UI components of the Drifty GUI has been added. Steps to download a file using both Drifty CLI and GUI have also been added
…nainmakada-99/master
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range, codebase verification and nitpick comments (26)
Website/app/docs/Usage/drifty-gui/downloading-files.md (1)
8-8: Convert bare URLs to hyperlinks.For better readability and adherence to Markdown standards, consider converting bare URLs to hyperlinks.
3. Wait for Drifty to automatically detect the file name and set it as the default file name.  6. Click on the **Start** button to begin downloading all the files in the queue. Also applies to: 17-17
Tools
Markdownlint
8-8: null
Bare URL used(MD034, no-bare-urls)
Website/app/docs/Faq.md (3)
3-3: Add a comma for clarity.Consider adding a comma after "Questions" for better readability.
1. **Why does Drifty GUI not open on my Windows machine?**Tools
LanguageTool
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
3-3: Use "on" instead of "in" for preposition.The preposition "on" is more appropriate than "in" when referring to a machine.
1. **Why does Drifty GUI not open on my Windows machine?**Tools
LanguageTool
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
36-36: Consider adding a question mark.The sentence seems to be a question and should end with a question mark.
8. **Do you require any detailed explanations of Drifty?**Tools
LanguageTool
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Website/app/docs/Development/Quickstart.md (2)
40-40: Consider rephrasing for clarity.Rephrase the sentence to make it more concise and clear.
3. Modify the code and rerun the project to see the changes reflected in the application.Tools
LanguageTool
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ll start the Drifty GUI application. 3. Make changes to the code and see them reflected in the ...(MAKE_CHANGES)
70-70: Consider rephrasing for clarity.Rephrase the sentence to make it more concise and clear.
Make changes to the website code in your IDE and see them reflected in real-time in the browser.Tools
LanguageTool
[style] ~70-~70: Consider shortening or rephrasing this to strengthen your wording.
Context: ...http://localhost:3000` in your browser. Make changes to the website code from your IDE and see ...(MAKE_CHANGES)
Website/app/docs/Usage/drifty-gui/Overview.md (5)
3-3: Consider rephrasing for clarity.The sentence "The main interface of Drifty GUI is where you will spend most of your time" could be clearer. Consider rephrasing to emphasize the importance of understanding the interface components.
- The main interface of Drifty GUI is where you will spend most of your time. + You will spend most of your time using the main interface of Drifty GUI, so it's important to understand its components and their functions.
17-17: Correct capitalization for consistency.The phrase "Suggesting features" should be capitalized consistently with other items in the list.
- Suggesting features + Suggest Features
22-22: Clarify functionality description.The description of the link input field could be more explicit about how Drifty checks for duplicate downloads.
- Drifty will try to automatically detect the file name and check if it exists in the download history and download directories to prevent duplicate downloads. + Drifty will automatically detect the file name and check if it already exists in the download history or download directories to prevent duplicate downloads.
27-27: Clarify directory management description.The description of managing directories could be clearer about how directories are added or managed.
- You can manage the directory by right-clicking on the directory input field to open the context menu, which shows all the download directories you have used in the past. + You can manage directories by right-clicking on the directory input field to open a context menu that lists all previously used download directories.
36-36: Clarify auto-paste feature description.The description of the auto-paste feature could be more concise.
- When you return to the app after copying a URL, the URL will be automatically pasted into the link input field. + When you return to the app after copying a URL, it will automatically paste into the link input field.Website/app/docs/Quickstart.md (2)
5-5: Clarify download instructions.The instruction to go to the official website could be more specific about where the download button is located.
- Go to the official website of Drifty and click on the download button. + Visit Drifty's official website and locate the download button on the homepage.
39-39: Capitalize "Linux" consistently.Ensure "Linux" is capitalized consistently throughout the document.
- For linux, open the terminal and navigate to the directory where the binary is downloaded and run the following command: + For Linux, open the terminal and navigate to the directory where the binary is downloaded and run the following command:Website/app/docs/Usage/drifty-cli/downloading-files.md (5)
5-5: Clarify download methods.Consider clarifying the descriptions of the three download methods for better understanding.
- 1. **Single File download**: You can download files one by one, providing the link to the file each time. + 1. **Single File Download**: Download individual files by providing their URLs one at a time.
15-15: Clarify URL validation step.The step about URL validation could be more explicit about what happens during validation.
- Once the URL is validated, you will be prompted to choose the download destination folder. + After validating the URL, Drifty will prompt you to choose a download destination folder.
33-33: Add comma after introductory phrase.Add a comma after the introductory phrase for grammatical correctness.
- For this example we are going to use the following data: + For this example, we are going to use the following data:Tools
LanguageTool
[typographical] ~33-~33: Use a comma after an introductory phrase.
Context: ...e list of URLs you want to download. For this example we are going to use the following data:...(COMMA_INTRODUCTORY_WORDS_PHRASES)
44-44: Add missing comma.Add a comma for clarity and grammatical correctness.
- The files will be downloaded sequentially to the default download directory as we have not specified a custom download location in our YAML file. + The files will be downloaded sequentially to the default download directory, as we have not specified a custom download location in our YAML file.Tools
LanguageTool
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...ed sequentially to the default download directory as we have not specified a custom downl...(AI_HYDRA_LEO_MISSING_COMMA)
49-49: Clarify queue usage instructions.Consider clarifying the instructions for using the Drifty CLI queue.
- 3. **Using Drifty CLI Queue**: Add multiple links to the download queue, and you can download them anytime you want. + 3. **Using Drifty CLI Queue**: Add multiple URLs to a download queue, allowing you to download them at your convenience.Website/app/docs/Usage/drifty-cli/Overview.md (4)
54-54: Improve sentence variety for clarity.Consider rephrasing the sentences to avoid starting multiple sentences with "If not specified."
- If **directory** is used, all files will be saved in the same given directory. If **directories** is used, each file will be saved in the corresponding directories specified according to the order of URLs. If not specified, the files will be saved in the last used directory or the default download directory (`{user_home}/Downloads`). + Use **directory** to save all files in the same directory. Use **directories** to save each file in the corresponding directory specified in the order of URLs. By default, files are saved in the last used directory or the default download directory (`{user_home}/Downloads`) if not specified.Tools
LanguageTool
[style] ~54-~54: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecified according to the order of URLs. If not specified, the files will be saved ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
99-99: Add a missing comma for clarity.A comma is needed before "or use
all."- You can specify the index of the URLs to remove or use `all` to clear the entire queue. + You can specify the index of the URLs to remove, or use `all` to clear the entire queue.Tools
LanguageTool
[uncategorized] ~99-~99: Possible missing comma found.
Context: ...ou can specify the index of the URLs to remove or useallto clear the entire queue....(AI_HYDRA_LEO_MISSING_COMMA)
122-123: Simplify phrasing for brevity.Consider replacing "in conjunction with" with "with" or "together with" for conciseness.
- It must be used in conjunction with the URL of the file you want to download. + It must be used with the URL of the file you want to download.Also applies to: 138-139
Tools
LanguageTool
[style] ~122-~122: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...t a standalone command. It must be used in conjunction with the URL of the file you want to downloa...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~123-~123: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...> You can also use the--namecommand in conjunction with this command. Command: `--location...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
143-143: Vary phrasing for readability.Consider rephrasing to add variety and avoid repetition.
- Specify a custom file name for the file you want to download. The file name should include the extension if applicable. If the file name is not specified, it will be automatically detected from the URL. + Specify a custom file name, including the extension if applicable. If not provided, the file name will be automatically detected from the URL.Tools
LanguageTool
[style] ~143-~143: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ify a custom file name for the file you want to download. The file name should include ...(REP_WANT_TO_VB)
Website/app/docs/Development/Building-Executables.md (1)
141-141: Correct repeated word for clarity.Remove the repeated word "Docker" in the prerequisites section.
- - [Docker](https://docs.docker.com/get-docker/) + - [Docker Compose](https://docs.docker.com/compose/install/)Tools
LanguageTool
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS-docker-build-instructions.md (3)
17-17: Hyphenate "up to date" for grammatical correctness.Add hyphens to "up to date" to form "up-to-date."
- This ensures that any libraries that might be necessary will be up to date. + This ensures that any libraries that might be necessary will be up-to-date.Tools
LanguageTool
[uncategorized] ~17-~17: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...braries that might be necessary will be up to date. ```bash brew update brew upgrade...(UP_TO_DATE_HYPHEN)
68-68: Add a missing comma for clarity.Add a comma after "lower in value."
- I recommend assigning an address that is lower in value which has a better chance of being outside the router's address pool. + I recommend assigning an address that is lower in value, which has a better chance of being outside the router's address pool.Tools
LanguageTool
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...d assigning an address that is lower in value which has a better chance of being outs...(AI_HYDRA_LEO_MISSING_COMMA)
70-70: Add the determiner "the" for grammatical correctness.Include "the" before "least macOS version 13."
- If you are not running at **_least macOS version 13 (Ventura)_** + If you are not running at **_the least macOS version 13 (Ventura)_**Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (10)
- Website/app/docs/Contributing.md (1 hunks)
- Website/app/docs/Development/Building-Executables.md (1 hunks)
- Website/app/docs/Development/Quickstart.md (1 hunks)
- Website/app/docs/Development/macOS-docker-build-instructions.md (1 hunks)
- Website/app/docs/Faq.md (1 hunks)
- Website/app/docs/Quickstart.md (1 hunks)
- Website/app/docs/Usage/drifty-cli/Overview.md (1 hunks)
- Website/app/docs/Usage/drifty-cli/downloading-files.md (1 hunks)
- Website/app/docs/Usage/drifty-gui/Overview.md (1 hunks)
- Website/app/docs/Usage/drifty-gui/downloading-files.md (1 hunks)
Files skipped from review due to trivial changes (1)
- Website/app/docs/Contributing.md
Additional context used
Markdownlint
Website/app/docs/Usage/drifty-gui/downloading-files.md
8-8: null
Bare URL used(MD034, no-bare-urls)
17-17: null
Bare URL used(MD034, no-bare-urls)
LanguageTool
Website/app/docs/Faq.md
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Website/app/docs/Development/Quickstart.md
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ll start the Drifty GUI application. 3. Make changes to the code and see them reflected in the ...(MAKE_CHANGES)
[style] ~70-~70: Consider shortening or rephrasing this to strengthen your wording.
Context: ...http://localhost:3000` in your browser. Make changes to the website code from your IDE and see ...(MAKE_CHANGES)
Website/app/docs/Quickstart.md
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...677f08-de5f-4ade-9414-881abe82edc4) - If you are using macOS, click on the downl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Website/app/docs/Usage/drifty-cli/downloading-files.md
[style] ~16-~16: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...stination folder. Enter -.if you want to download the video in the default downl...(REP_WANT_TO_VB)
[style] ~17-~17: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nloadsin most cases). -L` if you want to use the last used directory. - the a...(REP_WANT_TO_VB)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...bsolute path of the directory where you want to save the video, e.g., `/home/user/Video...(REP_WANT_TO_VB)
[typographical] ~33-~33: Use a comma after an introductory phrase.
Context: ...e list of URLs you want to download. For this example we are going to use the following data:...(COMMA_INTRODUCTORY_WORDS_PHRASES)
[uncategorized] ~44-~44: Possible missing comma found.
Context: ...ed sequentially to the default download directory as we have not specified a custom downl...(AI_HYDRA_LEO_MISSING_COMMA)
Website/app/docs/Usage/drifty-cli/Overview.md
[style] ~54-~54: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ecified according to the order of URLs. If not specified, the files will be saved ...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[uncategorized] ~99-~99: Possible missing comma found.
Context: ...ou can specify the index of the URLs to remove or useallto clear the entire queue....(AI_HYDRA_LEO_MISSING_COMMA)
[style] ~122-~122: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...t a standalone command. It must be used in conjunction with the URL of the file you want to downloa...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~123-~123: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...> You can also use the--namecommand in conjunction with this command. Command: `--location...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~138-~138: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...t a standalone command. It must be used in conjunction with the URL of the file you want to downloa...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~139-~139: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...u can also use the--locationcommand in conjunction with this command. Command: `--name <fi...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~143-~143: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...ify a custom file name for the file you want to download. The file name should include ...(REP_WANT_TO_VB)
Website/app/docs/Development/Building-Executables.md
[uncategorized] ~37-~37: You might be missing the article “the” here.
Context: ...e GraalVM metadata will be generated in `src/main/resources/META-INF/native-image...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
[duplication] ~141-~141: Possible typo: you repeated a word
Context: ... ## Docker Build ### Prerequisites - Docker - [Docker Compose](https://docs.docker.com/compos...(ENGLISH_WORD_REPEAT_RULE)
Website/app/docs/Development/macOS-docker-build-instructions.md
[uncategorized] ~17-~17: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...braries that might be necessary will be up to date. ```bash brew update brew upgrade...(UP_TO_DATE_HYPHEN)
[uncategorized] ~68-~68: Possible missing comma found.
Context: ...d assigning an address that is lower in value which has a better chance of being outs...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
[uncategorized] ~77-~77: Possible missing comma found.
Context: ...e I have it here, regardless of your ip address and your router will always be.1(in...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (6)
Website/app/docs/Usage/drifty-gui/downloading-files.md (1)
1-17: LGTM!The instructions are clear and well-structured.
Tools
Markdownlint
8-8: null
Bare URL used(MD034, no-bare-urls)
17-17: null
Bare URL used(MD034, no-bare-urls)
Website/app/docs/Faq.md (1)
1-35: LGTM!The FAQ content is informative and well-organized.
Tools
LanguageTool
[typographical] ~3-~3: Consider adding a comma here.
Context: ...y Asked Questions 1. Why does Drifty GUI not open in my Windows machine? ...(NN_NOT_NN_COMMA)
[uncategorized] ~3-~3: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ...ions 1. Why does Drifty GUI not open in my Windows machine? ➡️ Your Wind...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
Website/app/docs/Development/Quickstart.md (1)
1-79: LGTM!The Quickstart guide is comprehensive and provides clear instructions for developers.
Tools
LanguageTool
[style] ~40-~40: Consider shortening or rephrasing this to strengthen your wording.
Context: ...ll start the Drifty GUI application. 3. Make changes to the code and see them reflected in the ...(MAKE_CHANGES)
[style] ~70-~70: Consider shortening or rephrasing this to strengthen your wording.
Context: ...http://localhost:3000` in your browser. Make changes to the website code from your IDE and see ...(MAKE_CHANGES)
Website/app/docs/Quickstart.md (2)
10-10: Fix indentation of unordered list items.Fix the indentation of unordered list items to adhere to Markdownlint rules.
16-16: Add missing article.Add the missing article "a" for grammatical correctness.
Website/app/docs/Development/Building-Executables.md (1)
37-37: Duplicate Comment: Fix grammatical issue by adding "the".The sentence is missing the article "the" before "GraalVM metadata."
Tools
LanguageTool
[uncategorized] ~37-~37: You might be missing the article “the” here.
Context: ...e GraalVM metadata will be generated in `src/main/resources/META-INF/native-image...(AI_EN_LECTOR_MISSING_DETERMINER_THE)
There was a problem hiding this comment.
Actionable comments posted: 1
Outside diff range, codebase verification and nitpick comments (5)
Website/app/docs/Usage/drifty-cli/downloading-files.md (1)
16-18: Consider varying the phrasing for stylistic improvement.The repeated use of "if you want to" can be replaced with alternative expressions to enhance readability and style.
- - `.` if you want to download the video in the default download directory (which is `{user_home}/Downloads` in most cases). - - `L` if you want to use the last used directory. - - the absolute path of the directory where you want to save the video, e.g., `/home/user/Videos`. + - `.` to download the video in the default download directory (typically `{user_home}/Downloads`). + - `L` to use the last used directory. + - the absolute path of the directory to save the video, e.g., `/home/user/Videos`.Tools
LanguageTool
[style] ~16-~16: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...stination folder. Enter -.if you want to download the video in the default downl...(REP_WANT_TO_VB)
[style] ~17-~17: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nloadsin most cases). -L` if you want to use the last used directory. - the a...(REP_WANT_TO_VB)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...bsolute path of the directory where you want to save the video, e.g., `/home/user/Video...(REP_WANT_TO_VB)
Website/app/docs/Usage/drifty-cli/Overview.md (1)
123-123: Consider simplifying the phrase for conciseness.The phrase "in conjunction with" can be replaced with "with" for brevity.
- > You can also use the `--name` command in conjunction with this command. + > You can also use the `--name` command with this command.Also applies to: 139-139
Tools
LanguageTool
[style] ~123-~123: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...> You can also use the--namecommand in conjunction with this command. Command: `--location...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
Website/app/docs/Development/macOS-docker-build-instructions.md (3)
17-17: Add hyphens to "up-to-date" for grammatical correctness.The phrase "up to date" should be hyphenated when used as an adjective.
- Update the local Homebrew repository and upgrade any outdated installations. This ensures that any libraries that might be necessary will be up to date. + Update the local Homebrew repository and upgrade any outdated installations. This ensures that any libraries that might be necessary will be up-to-date.Tools
LanguageTool
[uncategorized] ~17-~17: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...braries that might be necessary will be up to date. ```bash brew update brew upgrade...(UP_TO_DATE_HYPHEN)
48-48: Add missing commas for grammatical correctness.Commas are needed to separate clauses for clarity.
- On most home networks, the typical setup is to have a router where your computer is connected to the LAN (Local Area network) side of the router either via Wi-Fi or an Ethernet cable. And most people just make that connection, find that they can access the Internet and don't look back. + On most home networks, the typical setup is to have a router where your computer is connected to the LAN (Local Area network) side of the router, either via Wi-Fi or an Ethernet cable. And most people just make that connection, find that they can access the Internet, and don't look back. - The subnet mask will look exactly like I have it here, regardless of your ip address and your router will always be `.1` (in most cases) as shown here. + The subnet mask will look exactly like I have it here, regardless of your IP address, and your router will always be `.1` (in most cases) as shown here.Also applies to: 77-77
Tools
LanguageTool
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...nnection, find that they can access the Internet and don't look back. > > We, however, n...(AI_HYDRA_LEO_MISSING_COMMA)
70-70: Add a determiner for grammatical correctness.A determiner is needed before "least" for clarity.
- If you are not running at **_least macOS version 13 (Ventura)_**, then refer to [**this article**](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) to get the instructions for **statically assigning your IP address**. + If you are not running at **_at least macOS version 13 (Ventura)_**, then refer to [**this article**](https://www.macinstruct.com/tutorials/how-to-set-a-static-ip-address-on-a-mac/) to get the instructions for **statically assigning your IP address**.Tools
LanguageTool
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (6)
- Website/app/docs/Development/macOS-docker-build-instructions.md (1 hunks)
- Website/app/docs/Faq.md (1 hunks)
- Website/app/docs/Quickstart.md (1 hunks)
- Website/app/docs/Usage/drifty-cli/Overview.md (1 hunks)
- Website/app/docs/Usage/drifty-cli/downloading-files.md (1 hunks)
- Website/app/docs/Usage/drifty-gui/Overview.md (1 hunks)
Additional context used
LanguageTool
Website/app/docs/Faq.md
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Website/app/docs/Usage/drifty-gui/Overview.md
[uncategorized] ~28-~28: The preposition “in” seems more likely in this position than the preposition “at”.
Context: ...d The directory input field is located at the middle-center portion of the window...(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_AT_IN)
Website/app/docs/Quickstart.md
[style] ~25-~25: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...677f08-de5f-4ade-9414-881abe82edc4) - If you are using macOS, click on the downl...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
Website/app/docs/Usage/drifty-cli/downloading-files.md
[style] ~16-~16: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...stination folder. Enter -.if you want to download the video in the default downl...(REP_WANT_TO_VB)
[style] ~17-~17: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...nloadsin most cases). -L` if you want to use the last used directory. - the a...(REP_WANT_TO_VB)
[style] ~18-~18: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...bsolute path of the directory where you want to save the video, e.g., `/home/user/Video...(REP_WANT_TO_VB)
Website/app/docs/Usage/drifty-cli/Overview.md
[style] ~123-~123: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...> You can also use the--namecommand in conjunction with this command. Command: `--location...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
[style] ~139-~139: ‘in conjunction with’ might be wordy. Consider a shorter alternative.
Context: ...u can also use the--locationcommand in conjunction with this command. Command: `--name <fi...(EN_WORDINESS_PREMIUM_IN_CONJUNCTION_WITH)
Website/app/docs/Development/macOS-docker-build-instructions.md
[uncategorized] ~17-~17: It appears that hyphens are missing in the adjective “up-to-date”.
Context: ...braries that might be necessary will be up to date. ```bash brew update brew upgrade...(UP_TO_DATE_HYPHEN)
[uncategorized] ~48-~48: Possible missing comma found.
Context: ...nnection, find that they can access the Internet and don't look back. > > We, however, n...(AI_HYDRA_LEO_MISSING_COMMA)
[grammar] ~70-~70: A determiner may be missing.
Context: ...ith that. If you are not running at least macOS version 13 (Ventura), then ref...(THE_SUPERLATIVE)
[uncategorized] ~77-~77: Possible missing comma found.
Context: ...e I have it here, regardless of your ip address and your router will always be.1(in...(AI_HYDRA_LEO_MISSING_COMMA)
Additional comments not posted (18)
Website/app/docs/Faq.md (8)
3-5: Clear and informative solution provided.The section clearly addresses the issue with the Drifty GUI on Windows and provides a solution.
7-9: Helpful IDE recommendation.The section provides a clear recommendation for using IntelliJ IDEA, which is appropriate for Java projects.
11-13: Clear instructions for getting updates.The section provides clear instructions on how to get updates related to the project.
15-21: Informative list of technologies.The section provides a comprehensive list of technologies used in Drifty.
23-25: Concise contribution instructions.The section effectively directs users to the contribution guidelines.
27-29: Clear update instructions.The section provides clear instructions on how to update Drifty.
31-33: Informative Beta features access.The section clearly explains how to access Beta features via Docker.
35-36: Add a question mark for grammatical correctness.The sentence should end with a question mark to align with the FAQ format.
- 8. **Do you require any detailed explanations of Drifty?** + 8. **Do you require any detailed explanations of Drifty?**Likely invalid or redundant comment.
Tools
LanguageTool
[typographical] ~36-~36: Should there be a question mark at the end of this sentence?
Context: ...](https://discord.com/invite/DeT4jXPfkG). We will be happy to help you out.(MISSING_QUESTION_MARK2)
Website/app/docs/Usage/drifty-gui/Overview.md (7)
3-4: Clear introduction to Drifty GUI.The section provides a concise and informative introduction to the Drifty GUI.
8-19: Well-structured Menu Bar description.The section effectively describes the menu bar options with helpful images.
21-24: Informative Link Input Field description.The section provides a clear explanation of the link input field's functionality.
31-33: Clear File Name Input Field description.The section effectively describes the file name input field and its default behavior.
35-37: Informative Auto-Paste Checkbox description.The section provides a clear explanation of the auto-paste checkbox feature.
39-41: Clear Start Button description.The section effectively describes the functionality of the start button.
43-46: Informative Download Queue description.The section provides a clear explanation of the download queue and its management options.
Website/app/docs/Quickstart.md (3)
3-6: Clear download instructions.The section provides clear instructions for downloading Drifty, with helpful images.
28-50: Comprehensive installation instructions for Drifty GUI.The section provides clear and detailed installation instructions for Drifty GUI on various platforms.
51-62: Clear installation instructions for Drifty CLI.The section provides clear and detailed installation instructions for Drifty CLI on various platforms.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
There was a problem hiding this comment.
Actionable comments posted: 0
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (1)
- Website/app/docs/Usage/drifty-gui/Overview.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
- Website/app/docs/Usage/drifty-gui/Overview.md
There was a problem hiding this comment.
@hasnainmakada-99 Looks good to merge 👍.
Thanks for contributing 🚀 🚀.
You may join our Discord server - https://discord.gg/DeT4jXPfkG to get updates about the project.
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)
Screenshots
NaN
Note to reviewers
NaN
Summary by CodeRabbit
Summary by CodeRabbit
New Features
Documentation