docs: add environment setup note for Docker installation by Mohit-001-hash · Pull Request #366 · Abhash-Chakraborty/Find

Mohit-001-hash · 2026-07-19T05:16:14Z

Summary

Added a missing environment setup note to the Docker installation section, reminding contributors to configure the .env file before running Docker commands. This improves the setup instructions and helps prevent configuration-related issues.

Contributor PRs must target canary. Only the maintainer promotion PR from
canary may target main.

Fixes #None (just a documentation quick fix)

Type of change

Release impact

No user-visible release note needed
Patch (backward-compatible fix)
Minor (backward-compatible feature)
Major (breaking change)
Critical/security fix (keep sensitive details private)

What changed

Added a note instructing contributors to configure the .env file before executing Docker commands.
Improved the clarity of the Docker setup instructions for first-time contributors.

Screenshots / recordings (for UI changes)

N/A

How to test

Verify that the new note appears in the Docker installation section of the README.
Confirm the added instructions are clear and correctly placed before the Docker commands.

Checklist

I linked the related issue
I ran required checks from CONTRIBUTING.md
I updated docs/env notes if needed
My PR is scoped to a single issue
I followed commit message conventions
I am not committing secrets or local artifacts
This PR targets canary unless it is the maintainer promotion PR

GSSoC'26 checklist

I requested issue assignment before starting
I have meaningful commits (no spam commits)
I am ready to explain my implementation in review comments

Summary by CodeRabbit

Documentation
- Clarified setup instructions by explaining how to create a local environment configuration file from the provided example.
- Added guidance to configure the required environment variables.

github-actions · 2026-07-19T05:16:27Z

PR Context Summary

Linked issue(s): none
Referenced but not closing: none
PR author trusted by GitHub: no
Dependabot PR: no
PR assignee synced from linked issue: no change
Macroscope review status: Waiting for under-review or ready-to-merge before triggering Macroscope.

Walkthrough

The README’s environment setup section now instructs contributors to copy .env.example to .env, configure required variables, and then continue with subsequent commands.

Changes

Environment setup documentation

Layer / File(s)	Summary
Document environment file initialization `README.md`	Adds a shell command to copy `.env.example` to `.env` and a note to configure required environment variables.

Estimated code review effort: 1 (Trivial) | ~2 minutes

Suggested reviewers: abhash-chakraborty

Poem

A bunny found a hidden file,
Copied it with a hop and smile.
“Set your vars before you start!”
Then docs and carrots played their part.

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly describes the doc change: adding an environment setup note for Docker installation.
Description check	✅ Passed	The description follows the template and covers summary, change type, release impact, testing, and checklists; only the issue reference is a placeholder.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

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.}

macroscopeapp · 2026-07-19T05:17:10Z

+```
+
 From repository root:
+```


🟢 Low README.md:114

The extra ``` line at line 114 opens a Markdown code fence before the existing ```bash block. As a result, the inner ```bash fence and its language marker render as literal text instead of a syntax-highlighted Docker command block, degrading the installation instructions. Remove the standalone ``` line so the ```bash block renders normally.

Suggested change

```

🤖 Copy this AI Prompt to have your agent fix this:

In file @README.md around line 114: The extra ` [code fence] ` line at line 114 opens a Markdown code fence before the existing ` [code fence]bash ` block. As a result, the inner ` [code fence]bash ` fence and its language marker render as literal text instead of a syntax-highlighted Docker command block, degrading the installation instructions. Remove the standalone ` [code fence] ` line so the ` [code fence]bash ` block renders normally.

macroscopeapp · 2026-07-19T05:17:36Z

Approvability

Verdict: Needs human review

Documentation-only change to README.md, but the author is not the designated code owner (owned by Abhash-Chakraborty). Additionally, there's an unresolved review comment about a markdown formatting issue (extra code fence at line 114) that would break rendering of installation instructions.

^{You can customize Macroscope's approvability policy. Learn more.}

Abhash-Chakraborty · 2026-07-29T10:26:11Z

Thanks — the .env step genuinely is missing from Option A, so the intent is right. The diff as written doesn't work though:

It breaks the markdown. The change adds a bare ``` on its own line right after From repository root:, which opens a fence that then swallows the docker compose up --build block below it. Rendered, the rest of that section falls apart. Drop that stray fence.
Duplicate lead-in. You add "From the repository root, ensure that you have copied…" immediately above the existing "From repository root:" line. Fold them into one sentence rather than having both.

Something like this is all it needs:

### Option A: full real-ML stack

From repository root, copy the example environment file and adjust it before starting the stack:

```bash
cp .env.example .env
```

Then:

```bash
docker compose up --build
```

Please also link an issue. The PR body says Fixes #None. For a docs fix this small it's fine to open a one-line issue for it and reference that, so the change is traceable — the needs linked issue label is on the PR for this reason.

Fix the fence and I'll merge it.

github-actions · 2026-07-29T10:26:30Z

@macroscope-app review

Please review this PR against its linked issue, local-first privacy rules, and the current Find repo instructions.
Linked issue(s): none linked yet.
Trigger source: label-gated review (under-review).

github-actions · 2026-07-30T10:10:47Z

This PR is marked as stale. It will close automatically after 7 days without renewed activity; remove the stale label when work resumes.

docs: add environment setup note for Docker installation

469ccb7

github-actions Bot added the needs linked issue Pull request needs to link a valid issue before review. label Jul 19, 2026

macroscopeapp Bot requested a review from Abhash-Chakraborty July 19, 2026 05:16

macroscopeapp Bot reviewed Jul 19, 2026

View reviewed changes

Abhash-Chakraborty added stale Marked stale; auto-closed 24h after labeling if not addressed. and removed under-review Maintainer needs to verify labels Jul 30, 2026

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: add environment setup note for Docker installation - #366

docs: add environment setup note for Docker installation#366
Mohit-001-hash wants to merge 1 commit into
Abhash-Chakraborty:canaryfrom
Mohit-001-hash:docs/add-env-setup-note

Mohit-001-hash commented Jul 19, 2026 •

edited by coderabbitai Bot

Loading

Uh oh!

github-actions Bot commented Jul 19, 2026 •

edited

Loading

Uh oh!

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

Walkthrough

Changes

Uh oh!

macroscopeapp Bot Jul 19, 2026

Uh oh!

macroscopeapp Bot commented Jul 19, 2026 •

edited

Loading

Uh oh!

Abhash-Chakraborty commented Jul 29, 2026

Uh oh!

github-actions Bot commented Jul 29, 2026

Uh oh!

github-actions Bot commented Jul 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

Mohit-001-hash commented Jul 19, 2026 • edited by coderabbitai Bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary

Type of change

Release impact

What changed

Screenshots / recordings (for UI changes)

How to test

Checklist

GSSoC'26 checklist

Summary by CodeRabbit

Uh oh!

github-actions Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

PR Context Summary

Suggested issue links

Uh oh!

coderabbitai Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Uh oh!

macroscopeapp Bot Jul 19, 2026

Choose a reason for hiding this comment

Uh oh!

macroscopeapp Bot commented Jul 19, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Approvability

Uh oh!

Abhash-Chakraborty commented Jul 29, 2026

Uh oh!

github-actions Bot commented Jul 29, 2026

Uh oh!

github-actions Bot commented Jul 30, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Mohit-001-hash commented Jul 19, 2026 •

edited by coderabbitai Bot

Loading

github-actions Bot commented Jul 19, 2026 •

edited

Loading

coderabbitai Bot commented Jul 19, 2026 •

edited

Loading

macroscopeapp Bot commented Jul 19, 2026 •

edited

Loading