docs(readme): expand org profile README - #3
Conversation
📝 WalkthroughWalkthroughThe Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
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.
Pull request overview
Expands the organization profile README to better describe Beep’s purpose, architecture, and how to get started contributing/running the stack locally.
Changes:
- Adds a short product/platform description and a Tech Stack section.
- Introduces a Services table that links to the major repos and summarizes responsibilities.
- Adds Quick Start instructions plus a Contributing link and License section.
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@profile/README.md`:
- Line 34: Replace the SSH-only clone command string "git clone
--recurse-submodules git@github.com:beep-industries/central.git" in the Quick
Start section with an HTTPS alternative (e.g., "git clone --recurse-submodules
https://github.com/beep-industries/central.git") or provide both forms
side-by-side so new users who haven't configured SSH keys can clone via HTTPS;
update the README.md Quick Start line accordingly.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
| The [`central`](https://github.com/beep-industries/central) repo contains a full-stack `docker-compose.yaml` to spin up every service and its infrastructure locally: | ||
|
|
||
| ```bash | ||
| git clone --recurse-submodules git@github.com:beep-industries/central.git |
There was a problem hiding this comment.
Use an HTTPS clone command in Quick Start (or provide both).
Line 34 currently requires SSH key setup, which can fail for new users doing a first-time local spin-up. Prefer HTTPS as the default in onboarding docs, or show both options.
Suggested doc tweak
-git clone --recurse-submodules git@github.com:beep-industries/central.git
+git clone --recurse-submodules https://github.com/beep-industries/central.git📝 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.
| git clone --recurse-submodules git@github.com:beep-industries/central.git | |
| git clone --recurse-submodules https://github.com/beep-industries/central.git |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@profile/README.md` at line 34, Replace the SSH-only clone command string "git
clone --recurse-submodules git@github.com:beep-industries/central.git" in the
Quick Start section with an HTTPS alternative (e.g., "git clone
--recurse-submodules https://github.com/beep-industries/central.git") or provide
both forms side-by-side so new users who haven't configured SSH keys can clone
via HTTPS; update the README.md Quick Start line accordingly.
Adds tech stack, services table, quick start, and contributing link to the org profile.
Summary by CodeRabbit