Skip to content

docs: add windows equivalent for copying .env file in install instructions #505

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Mohit-001-hash wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: add windows equivalent for copying .env file in install instructions #505

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,18 @@ The current Prisma schema centers around:
- MongoDB instance, local or hosted
- OAuth applications for GitHub and Google if you want full sign-in support

```markdown
### Install

```bash
git clone https://github.com/piyushdotcomm/Editron.git
git clone [https://github.com/piyushdotcomm/Editron.git](https://github.com/piyushdotcomm/Editron.git)

@qodo-code-review qodo-code-review Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

3. Broken git clone command 🐞 Bug ≡ Correctness

The install command was changed to Markdown link syntax (git clone [url](url)), which is not a
valid shell command and will fail when copied into a terminal.
Agent Prompt 
### Issue description
The README's `git clone` instruction uses Markdown link syntax, which is not shell-valid when copied.

### Issue Context
Install steps are intended to be copy-pasted into a shell.

### Fix Focus Areas
- README.md[94-97]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

cd Editron
npm install

# On macOS and Linux:
cp .env.example .env
# On Windows (Command Prompt):

@qodo-code-review qodo-code-review Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remediation recommended

4. Wrong windows comment syntax 🐞 Bug ≡ Correctness

The README labels the Windows instructions as Command Prompt but uses # comment lines, which CMD
does not treat as comments; users pasting the block will see errors.
Agent Prompt 
### Issue description
Windows instructions are labeled "Command Prompt" but use `#` comments, which are invalid in CMD.

### Issue Context
`#` is a comment marker in bash/PowerShell, but not in Windows Command Prompt. Either change the label to PowerShell, move OS labels outside the code block, or use CMD comment syntax (`REM`/`::`).

### Fix Focus Areas
- README.md[99-102]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

copy .env.example .env
```
Comment on lines +91 to 103

@qodo-code-review qodo-code-review Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

1. Updated root readme.md docs 📘 Rule violation ⚙ Maintainability

The PR modifies documentation in README.md at the repository root instead of placing the updated
doc content under /docs. This violates the requirement that documentation changes must be located
under /docs (or existing docs outside /docs should only be modified to relocate them).
Agent Prompt 
## Issue description
Documentation changes were made in the root `README.md`, but the compliance rule requires documentation files/updates to live under `/docs`.

## Issue Context
This PR adds Windows-specific install instructions; per the checklist, documentation updates should be placed in `/docs` (and root docs should only be changed to relocate them).

## Fix Focus Areas
- README.md[91-103]
- docs/INSTALLATION.md[1-200]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Comment on lines +91 to 103

@qodo-code-review qodo-code-review Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Action required

2. Install section fenced off 🐞 Bug ≡ Correctness

README.md opens a ```markdown fence before the Install heading, causing the entire Install section
(including the intended ```bash block) to render as literal code instead of a heading and
copy-pastable commands.
Agent Prompt 
### Issue description
The Install section is accidentally wrapped in a fenced code block (` ```markdown `), so the heading and commands render as literal text.

### Issue Context
A ` ```markdown ` fence was added immediately before `### Install` but the next closing fence appears only after the install commands, effectively swallowing the whole section.

### Fix Focus Areas
- README.md[91-103]

ⓘ Copy this prompt and use it to remediate the issue with your preferred AI generation tools

Comment on lines +91 to 103

@coderabbitai coderabbitai Bot Jul 2, 2026

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

📐 Maintainability & Code Quality | 🟡 Minor | ⚡ Quick win

Keep the install instructions out of a markdown code fence.

As written, the Install heading and .env commands will render as literal code, and the Windows example is still labeled as bash. Please remove the outer fence and split the shell examples into separate bash and cmd blocks so each platform renders correctly.

Suggested layout 
-```markdown
 ### Install
 
-```bash
 git clone https://github.com/piyushdotcomm/Editron.git
 cd Editron
 npm install
-
-# On macOS and Linux:
-cp .env.example .env
-
-# On Windows (Command Prompt):
-copy .env.example .env
-```
+```bash
+# On macOS and Linux:
+cp .env.example .env
+```
+
+```cmd
+# On Windows (Command Prompt):
+copy .env.example .env
+```
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
```markdown
### Install
```bash
git clone https://github.com/piyushdotcomm/Editron.git
git clone [https://github.com/piyushdotcomm/Editron.git](https://github.com/piyushdotcomm/Editron.git)
cd Editron
npm install
# On macOS and Linux:
cp .env.example .env
# On Windows (Command Prompt):
copy .env.example .env
```
### Install
git clone https://github.com/piyushdotcomm/Editron.git
cd Editron
npm install
🤖 Prompt for AI Agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@README.md` around lines 91 - 103, The Install section is wrapped in an outer
markdown fence, causing the heading and setup steps to render as literal code;
remove that wrapper in README.md and keep the top-level install text as normal
markdown. In the install block, use the existing clone, cd, and npm install
steps as plain lines, then split the environment setup into two separate fenced
snippets: one labeled bash for the macOS/Linux cp .env.example .env command and
one labeled cmd for the Windows copy .env.example .env command, so the
platform-specific examples render correctly.


### Environment variables
Expand Down