Update Manual Setup Guide to include Miniconda installation instructions#971
Conversation
|
|
📝 WalkthroughWalkthroughDocumentation 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
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
Pre-merge checks✅ Passed checks (3 passed)
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. Comment |
|
|
There was a problem hiding this comment.
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
📒 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.
| Bash(Linux/MacOS) | ||
| Bash/Powershell | ||
|
|
||
| ``` |
There was a problem hiding this comment.
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
| 4. **Update PATH (Important):** Ensure the conda environment's binaries are prioritized: | ||
|
|
||
| Bash(Linux/MacOS) | ||
| Bash (Linux/MacOS) |
There was a problem hiding this comment.
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.
* 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>
Summary by CodeRabbit
Release Notes
✏️ Tip: You can customize this high-level summary in your review settings.