docs: add troubleshooting block to quickstart#1152
docs: add troubleshooting block to quickstart#1152muddlebee merged 1 commit intoTracer-Cloud:mainfrom
Conversation
Greptile SummaryThis PR adds a three-item Troubleshooting section to the bottom of Confidence Score: 5/5Safe to merge — documentation-only change with no code impact. All findings are P2 style suggestions. The only concern is one troubleshooting bullet referencing docs/quickstart.mdx — the Important Files Changed
Reviews (1): Last reviewed commit: "docs: add troubleshooting block to quick..." | Re-trigger Greptile |
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
| ## Troubleshooting | ||
|
|
||
| - **Docker is not running**: Start Docker Desktop, OrbStack, or Colima before running setup. | ||
| - **`make` is missing**: Install it via your package manager (`brew install make` on macOS, `choco install make` on Windows). |
There was a problem hiding this comment.
make tip not relevant to quickstart steps
The quickstart guide only uses opensre CLI commands — none of the steps invoke make. This bullet may confuse end users who followed the guide and wonder when they would have encountered a missing make error. The make toolchain is used for contributor/development workflows (e.g., make install, make test-cov), not the user-facing install path shown here. Consider either removing this bullet or scoping it to a developer/contributing guide instead.
| - **`make` is missing**: Install it via your package manager (`brew install make` on macOS, `choco install make` on Windows). | |
| - **`make` is missing**: Install it via your package manager (`brew install make` on macOS, `choco install make` on Windows). This is only needed for contributor/development workflows, not the standard quickstart. |
|
🏄 Some PRs rot in review for six weeks. @PrakharJain345's said "not today" and merged like it owned the place. 🌊
👋 Join us on Discord - OpenSRE : hang out, contribute, or hunt for features and issues. Everyone's welcome. |
2 participants
Fixes #1131
Describe the changes you have made in this PR -
Added a quick troubleshooting block to the bottom of the
docs/quickstart.mdxfile. This provides new contributors with immediate, actionable solutions for the three most common setup issues: Docker not running, missingmakecommand, and missing local LLM provider configuration.Demo/Screenshot for feature changes and bug fixes -
N/A - This is purely a documentation update to
docs/quickstart.mdx.Code Understanding and AI Usage
Did you use AI assistance (ChatGPT, Claude, Copilot, etc.) to write any part of this code?
If you used AI assistance:
Explain your implementation approach:
This PR simply adds a Markdown section at the bottom of the Quickstart guide. Since it is a documentation update, no code logic or functions were added. I ensured the wording is extremely concise and actionable as requested by the issue, keeping the file clean and easy to scan.
Checklist before requesting a review