Update Manual Setup Guide to include Miniconda installation instructions #971

rahulharpal1603 · 2026-01-06T16:12:21Z

Summary by CodeRabbit

Release Notes

Documentation
- Updated setup guide to use Miniconda for environment management.
- Added prerequisites section with Miniconda installation and verification steps.
- Improved setup instructions with Conda environment workflows and consistent command documentation for all operating systems.
- Enhanced clarity on environment activation and dependency installation procedures.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

github-actions · 2026-01-06T16:12:39Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai · 2026-01-06T16:12:44Z

📝 Walkthrough

Walkthrough

Documentation update replacing virtualenv and Python 3.12-specific setup instructions with Miniconda-based environment management. Adds prerequisites section and updates backend and sync-microservice setup sections with conda environment creation, activation, and running instructions.

Changes

Cohort / File(s)	Summary
Documentation Setup Guide `docs/Manual_Setup_Guide.md`	Added Prerequisites section for Miniconda installation and verification; replaced virtualenv with conda environments (conda create/activate); updated Python Backend Setup and Sync-Microservice Setup sections; adjusted command blocks and OS-specific headings (Bash/Powershell); updated running steps to reference conda-activated environments

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐰 A rabbit's whisper on the setup breeze,
"Swap virtualenv for conda with ease!
Miniconda sprouts in every heart,
Prerequisites bloom—the perfect start.
From backend to service, consistency grows,
One guide to guide you wherever wind blows." 🌱

Pre-merge checks

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title directly and clearly summarizes the main change: updating the setup guide to include Miniconda installation instructions, which aligns with the core objectives of replacing virtualenv with Conda environments throughout the documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

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

github-actions · 2026-01-06T16:14:34Z

⚠️ No issue was linked in the PR description.
Please make sure to link an issue (e.g., 'Fixes #issue_number')

coderabbitai

Actionable comments posted: 2

🤖 Fix all issues with AI Agents

In @docs/Manual_Setup_Guide.md:
- Line 91: Replace the incorrect "MacOS" capitalization with the correct "macOS"
in both places mentioned (the "Bash (Linux/MacOS)" heading at the occurrence
around the "Bash" line and the second instance around line 155); update both
instances so they read "macOS" exactly, preserving surrounding text and
formatting.
- Line 77: Markdown code fences in the "Backend Setup" and "Sync-Microservice
Setup" sections are missing language specifiers; update each of the 10 flagged
fenced code blocks to include the appropriate language identifier (e.g., ```bash
or ```powershell) so the snippets like the conda create/activate commands,
export PATH, $env:PATH, pip install, and their counterparts in the
sync-microservice section are fenced as ```bash or ```powershell respectively.

📜 Review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 4647bac and 1f112f2.

📒 Files selected for processing (1)

docs/Manual_Setup_Guide.md

🧰 Additional context used

🪛 LanguageTool

docs/Manual_Setup_Guide.md

[uncategorized] ~91-~91: The operating system from Apple is written “macOS”.
Context: ...aries are prioritized: Bash (Linux/MacOS) ``` export PATH="$CONDA_PREFI...

(MAC_OS)

[uncategorized] ~155-~155: The operating system from Apple is written “macOS”.
Context: ...aries are prioritized: Bash (Linux/MacOS) ``` export PATH="$CONDA_PREFI...

(MAC_OS)

🪛 markdownlint-cli2 (0.18.1)

docs/Manual_Setup_Guide.md

77-77: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

85-85: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

93-93: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

99-99: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

109-109: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

141-141: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

149-149: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

157-157: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

163-163: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

173-173: Fenced code blocks should have a language specified

(MD040, fenced-code-language)

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (1)

GitHub Check: Backend Tests

🔇 Additional comments (1)

docs/Manual_Setup_Guide.md (1)

27-42: Prerequisites section is well-structured. Clear installation and verification steps with link to official documentation.

coderabbitai · 2026-01-06T16:14:56Z

docs/Manual_Setup_Guide.md

-    Bash(Linux/MacOS)
+    Bash/Powershell

    ```


⚠️ Potential issue | 🟠 Major

Add language specifiers to fenced code blocks.

Markdown linting requires language specifiers for all fenced code blocks. Update the backticks to include the language identifier (e.g., ```bash or ```powershell).

For example, the block at lines 77-79:

Bash/Powershell

conda create -n .env python=3.12

Should be:

Bash ```bash conda create -n .env python=3.12

Powershell

conda create -n .env python=3.12

This applies to all 10 code blocks flagged by the linter. <details> <summary>🔎 Proposed fixes for code block language specifiers</summary> All code blocks need language identifiers added. Below are the affected lines with proposed changes: **Backend Setup (lines 77-111):** ```diff - ``` + ```bash conda create -n .env python=3.12

```diff - ``` + ```bash conda activate ./.env

```diff - ``` + ```bash export PATH="$CONDA_PREFIX/bin:$PATH"

```diff - ``` + ```powershell $env:PATH = "$env:CONDA_PREFIX\Scripts;$env:PATH"

```diff - ``` + ```bash pip install -r requirements.txt

**Sync-Microservice Setup (lines 141-175):** Apply the same language specifier additions to the matching code blocks in the sync-microservice section. </details> Also applies to: 85-85, 93-93, 99-99, 109-109, 141-141, 149-149, 157-157, 163-163, 173-173 <details> <summary>🧰 Tools</summary> <details> <summary>🪛 markdownlint-cli2 (0.18.1)</summary> 77-77: Fenced code blocks should have a language specified (MD040, fenced-code-language) </details> </details> <details> <summary>🤖 Prompt for AI Agents</summary>

In @docs/Manual_Setup_Guide.md at line 77, Markdown code fences in the "Backend
Setup" and "Sync-Microservice Setup" sections are missing language specifiers;
update each of the 10 flagged fenced code blocks to include the appropriate
language identifier (e.g., bash or powershell) so the snippets like the
conda create/activate commands, export PATH, $env:PATH, pip install, and their
counterparts in the sync-microservice section are fenced as ```bash or

coderabbitai · 2026-01-06T16:14:56Z

docs/Manual_Setup_Guide.md

+4.  **Update PATH (Important):** Ensure the conda environment's binaries are prioritized:

-    Bash(Linux/MacOS)
+    Bash (Linux/MacOS)


⚠️ Potential issue | 🟡 Minor

Correct macOS spelling (not "MacOS").

Update both instances to use the correct capitalization: macOS (not MacOS).

🔎 Proposed fixes

Line 91:

- Bash (Linux/MacOS) + Bash (Linux/macOS)

Line 155:

- Bash (Linux/MacOS) + Bash (Linux/macOS)

Also applies to: 155-155

🧰 Tools

🪛 LanguageTool

[uncategorized] ~91-~91: The operating system from Apple is written “macOS”.
Context: ...aries are prioritized: Bash (Linux/MacOS) ``` export PATH="$CONDA_PREFI...

(MAC_OS)

🤖 Prompt for AI Agents

In @docs/Manual_Setup_Guide.md at line 91, Replace the incorrect "MacOS" capitalization with the correct "macOS" in both places mentioned (the "Bash (Linux/MacOS)" heading at the occurrence around the "Bash" line and the second instance around line 155); update both instances so they read "macOS" exactly, preserving surrounding text and formatting.

…ons (AOSSIE-Org#971)

* Update Manual Setup Guide to include Miniconda installation instructions (AOSSIE-Org#971) * Update conda create command's flags * Fix docs mobile responsiveness: prevent horizontal overflow, wrap long text (AOSSIE-Org#763) Co-authored-by: Hardik Mathur <hardikmathur11@gmial.com> * fix: upgrade pre-commit hooks for ruff and black and reformated some files acc to new versions (AOSSIE-Org#1073) * feat: Implemented spawing and closing of backend & sync microservice from tauri application --------- Co-authored-by: Hardik Mathur <hardikmathur11@gmail.com> Co-authored-by: Hardik Mathur <hardikmathur11@gmial.com> Co-authored-by: Tushar Gupta <36126341+tushar1977@users.noreply.github.com> Co-authored-by: Tushar Gupta <tushar.197712@gmail.com>

Update Manual Setup Guide to include Miniconda installation instructions

1f112f2

rahulharpal1603 merged commit 63330a8 into AOSSIE-Org:main Jan 6, 2026
5 of 6 checks passed

coderabbitai bot reviewed Jan 6, 2026

View reviewed changes

tushar1977 pushed a commit to tushar1977/PictoPy that referenced this pull request Jan 25, 2026

Update Manual Setup Guide to include Miniconda installation instructi…

19b7f53

…ons (AOSSIE-Org#971)

coderabbitai bot mentioned this pull request Jan 25, 2026

Use Conda for backend & sync-microservice setup on Windows #1076

Open

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Manual Setup Guide to include Miniconda installation instructions #971

Update Manual Setup Guide to include Miniconda installation instructions #971

Uh oh!

rahulharpal1603 commented Jan 6, 2026 •

edited by coderabbitai bot

Loading

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

coderabbitai bot commented Jan 6, 2026 •

edited

Loading

Walkthrough

Changes

Estimated code review effort

Poem

Uh oh!

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Jan 6, 2026

Uh oh!

coderabbitai bot Jan 6, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

Update Manual Setup Guide to include Miniconda installation instructions #971

Update Manual Setup Guide to include Miniconda installation instructions #971

Uh oh!

Conversation

rahulharpal1603 commented Jan 6, 2026 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Release Notes

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

coderabbitai bot commented Jan 6, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Estimated code review effort

Poem

Pre-merge checks

Uh oh!

Uh oh!

github-actions bot commented Jan 6, 2026

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Jan 6, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

1 participant

rahulharpal1603 commented Jan 6, 2026 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 6, 2026 •

edited

Loading