Skip to content

docs: Fix incorrect path to .env.example in ClientSetup.md#41670

Open
cyphercodes wants to merge 1 commit intoappsmithorg:releasefrom
cyphercodes:fix/client-setup-docs-env-path
Open

docs: Fix incorrect path to .env.example in ClientSetup.md#41670
cyphercodes wants to merge 1 commit intoappsmithorg:releasefrom
cyphercodes:fix/client-setup-docs-env-path

Conversation

@cyphercodes
Copy link
Copy Markdown

@cyphercodes cyphercodes commented Mar 29, 2026

Summary

Fixed the documentation path for copying the .env.example file in the ClientSetup.md guide.

Problem

The documentation at instructed users to run from what appears to be the directory context, but the file is located at the repository root, not in .

Solution

Updated the instruction to use the correct relative path:

Changes

  • : Fixed the path from to

Fixes #41586

Summary by CodeRabbit

  • Documentation
    • Updated development setup instructions to reflect the correct file path and working directory context for environment configuration.

The documentation incorrectly referenced .env.example in the current
directory, but the file is actually located at the repository root.
Updated the instruction to use the correct relative path from the
app/client directory.

Fixes appsmithorg#41586
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai bot commented Mar 29, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro

Run ID: 20bec97b-2fcd-49df-80b2-781f4b60820d

📥 Commits

Reviewing files that changed from the base of the PR and between b47d782 and d227f2a.

📒 Files selected for processing (1)
  • contributions/ClientSetup.md

Walkthrough

Documentation correction updating the environment file copy command to use the correct relative path from the client directory context.

Changes

Cohort / File(s) Summary
Development Setup Documentation
contributions/ClientSetup.md
Updated the .env file copy command from cp .env.example .env to cp ../../.env.example .env to reflect the correct relative path when executed from the app/client directory.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

📋 A path was lost in the setup guide,
But now the .env file's nowhere to hide,
Two dots up, one dot back in place,
Development setup wins the race! 🚀

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name Status Explanation Resolution
Description check ❓ Inconclusive The description provides context and explains the problem and solution, but omits required template sections like 'Automation' and explicit 'Communication' checkbox selection. Complete the template by filling out the 'Automation' and 'Communication' sections, particularly selecting Yes or No for the DevRel/Marketing notification question.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main change: fixing an incorrect path to .env.example in the ClientSetup.md documentation file.
Linked Issues check ✅ Passed The PR directly addresses issue #41586 by correcting the documented path from 'cp .env.example .env' to 'cp ../../.env.example .env', enabling proper local client setup as required.
Out of Scope Changes check ✅ Passed The change is narrowly scoped to fixing the .env.example path in ClientSetup.md documentation, with no extraneous modifications or out-of-scope work included.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Bug]: The development setup documentation for Client has error for ".env" file

1 participant