docs: add SETUP.md for contributor onboarding (Windows, Android, common issues)#15
docs: add SETUP.md for contributor onboarding (Windows, Android, common issues)#15SISIR-REDDY wants to merge 1 commit intoAOSSIE-Org:mainfrom
Conversation
Closes AOSSIE-Org#3 - Adds step-by-step SETUP.md covering Flutter SDK install (Windows, macOS, Linux), Android Studio + SDK Manager configuration, AVD creation, .env API key setup, and a Common Issues section for the errors new contributors typically hit (emulator mic, gradle clean, proxy, etc.) - Fixes the placeholder clone URL in README.md (yourusername/docpilot → AOSSIE-Org/DocPilot) - Adds a link to SETUP.md from the Getting Started section of README.md
📝 WalkthroughWalkthroughThis PR adds comprehensive setup documentation for new contributors by creating a new SETUP.md guide and updating README.md with specific versioned requirements, proper repository URLs, API key configuration steps, and explicit dependency installation instructions. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~15 minutes Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 3
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@SETUP.md`:
- Around line 133-136: The fenced code block showing environment variable
examples in SETUP.md lacks a language specifier; update the opening fence to
include a language (e.g., change "```" to "```dotenv" or "```bash") so
markdownlint passes and syntax highlighting works for the
GEMINI_API_KEY/DEEPGRAM_API_KEY example.
- Around line 42-45: The fenced code block containing the commands "flutter
--version" and "flutter doctor" lacks a language tag; update the opening fence
from ``` to ```bash so the block is tagged as bash (ensuring markdownlint MD040
compliance) near the code snippet in SETUP.md.
- Line 80: Replace the outdated bullet "Intel HAXM *(Windows only — required for
emulator acceleration)*" with guidance that recommends Windows Hypervisor
Platform (WHPX) as the primary emulator acceleration method on Windows and lists
Android Emulator Hypervisor Driver (AEHD) as an alternative (note AEHD sunset
scheduled for Dec 31, 2026); update the phrasing around the original "Intel
HAXM" text so it explicitly states HAXM is no longer supported by modern Android
Emulator releases (e.g., 36.2.x.x) and provide brief actionable instructions to
enable WHPX (and mention AEHD as fallback).
| ``` | ||
| flutter --version | ||
| flutter doctor | ||
| ``` |
There was a problem hiding this comment.
Add fenced code block language for command snippet.
This block should be tagged (e.g., bash) to satisfy markdownlint MD040.
Suggested fix
- ```
+ ```bash
flutter --version
flutter doctor
```📝 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.
| ``` | |
| flutter --version | |
| flutter doctor | |
| ``` |
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 42-42: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@SETUP.md` around lines 42 - 45, The fenced code block containing the commands
"flutter --version" and "flutter doctor" lacks a language tag; update the
opening fence from ``` to ```bash so the block is tagged as bash (ensuring
markdownlint MD040 compliance) near the code snippet in SETUP.md.
| - Android SDK Build-Tools | ||
| - Android Emulator | ||
| - Android SDK Platform-Tools | ||
| - Intel HAXM *(Windows only — required for emulator acceleration)* |
There was a problem hiding this comment.
🧩 Analysis chain
🌐 Web query:
Is Intel HAXM still required for Android Emulator acceleration on Windows in current Android Studio versions, or should docs recommend WHPX/Android Emulator Hypervisor Driver instead?
💡 Result:
Intel HAXM is no longer required (and, for current Emulator versions, no longer usable) for Android Emulator acceleration on Windows.
- Google’s official acceleration docs state that starting with Android Emulator 36.2.x.x, the emulator won’t use HAXM anymore, and they recommend Windows Hypervisor Platform (WHPX) instead. They also describe Android Emulator Hypervisor Driver (AEHD) as an alternative hypervisor on Windows (with a stated sunset date of Dec 31, 2026, after which users should transition to WHPX). [1]
- The official Emulator release notes for 36.2.11 (Oct 9, 2025) explicitly say “HAXM support is removed from the Emulator” and that users will be prompted to install AEHD if they try to use HAXM. [2]
So yes: current docs should recommend WHPX first, and mention AEHD as an alternative (not HAXM), with the caveat that AEHD is planned to be sunset at the end of 2026. [1]
Sources: [1] [2]
Replace outdated Intel HAXM requirement with current Windows hypervisor guidance.
Intel HAXM is no longer supported on Windows—as of Android Emulator 36.2.x.x (released Oct 2025), HAXM support has been removed and the emulator will no longer use it. Line 80 should instead recommend Windows Hypervisor Platform (WHPX) as the primary acceleration method, with Android Emulator Hypervisor Driver (AEHD) as an alternative (sunset scheduled for Dec 31, 2026).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@SETUP.md` at line 80, Replace the outdated bullet "Intel HAXM *(Windows only
— required for emulator acceleration)*" with guidance that recommends Windows
Hypervisor Platform (WHPX) as the primary emulator acceleration method on
Windows and lists Android Emulator Hypervisor Driver (AEHD) as an alternative
(note AEHD sunset scheduled for Dec 31, 2026); update the phrasing around the
original "Intel HAXM" text so it explicitly states HAXM is no longer supported
by modern Android Emulator releases (e.g., 36.2.x.x) and provide brief
actionable instructions to enable WHPX (and mention AEHD as fallback).
| ``` | ||
| GEMINI_API_KEY=your_gemini_api_key_here | ||
| DEEPGRAM_API_KEY=your_deepgram_api_key_here | ||
| ``` |
There was a problem hiding this comment.
Add fenced code block language for .env example.
This block should declare a language (e.g., dotenv or bash) for markdownlint compliance.
Suggested fix
-```
+```dotenv
GEMINI_API_KEY=your_gemini_api_key_here
DEEPGRAM_API_KEY=your_deepgram_api_key_here</details>
<!-- suggestion_start -->
<details>
<summary>📝 Committable suggestion</summary>
> ‼️ **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.
```suggestion
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)
[warning] 133-133: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@SETUP.md` around lines 133 - 136, The fenced code block showing environment
variable examples in SETUP.md lacks a language specifier; update the opening
fence to include a language (e.g., change "```" to "```dotenv" or "```bash") so
markdownlint passes and syntax highlighting works for the
GEMINI_API_KEY/DEEPGRAM_API_KEY example.
|
Hey @SharkyBytes I have reviewed this PR. It is great for a detailed setup guide. I think it is ready to merge but before that we can ask ishaan400 whether he is working or not. |
2 participants
Closes #3
Problem
The README's Getting Started section was too brief for new contributors — particularly those on Windows — to get DocPilot running without guesswork. Common blockers like accepting Android SDK licenses, emulator microphone limitations, and proxy-related pub failures were undocumented.
The README also had a placeholder clone URL (
yourusername/docpilot) instead of the real repo path.Changes
SETUP.md(new file)A step-by-step contributor setup guide covering:
flutter doctor --android-licensesto accept licenses.envfile creation with links to Deepgram and Gemini API key consolesadbnot in PATHMissingPluginExceptionon first runflutter pub getREADME.mdSETUP.mdyourusername/docpilot→AOSSIE-Org/DocPilot)Summary by CodeRabbit