chore(readme): Update README with new videos #410
Conversation
|
Warning Rate limit exceeded@msukkari has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 23 minutes and 16 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. 📒 Files selected for processing (2)
WalkthroughA new entry was added to the changelog documenting README updates. The README itself was revised to rename and update demo links, remove the Discord badge, expand and restructure the introduction and features sections, update deployment and configuration links, and adjust formatting and section headings. Additionally, a video source URL in the documentation was changed from an external to a local path. No code or functional changes were made. Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Poem
✨ Finishing Touches🧪 Generate unit tests
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
This comment has been minimized.
This comment has been minimized.
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
60-65: Replace bare URLs with Markdown images to satisfy MD034 and improve readability
markdownlintflags these two naked URLs. Turning them into proper image embeds keeps the visual intent while silencing the linter.-https://github.com/user-attachments/assets/feb82cde-51fc-42f9-830d-8f149d328a0b + ... -https://github.com/user-attachments/assets/022f0bd0-db45-45ba-a31f-7bd43b6e2e25 +
114-114: Add the missing period after “etc.”Grammar/lint nit picked up by LanguageTool.
-To configure Sourcebot (index your own repos, connect your LLMs, etc), check out our [docs](https://docs.sourcebot.dev/docs/configuration/config-file). +To configure Sourcebot (index your own repos, connect your LLMs, etc.), check out our [docs](https://docs.sourcebot.dev/docs/configuration/config-file).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
CHANGELOG.md(1 hunks)README.md(3 hunks)
🧰 Additional context used
📓 Path-based instructions (1)
**/*
📄 CodeRabbit Inference Engine (.cursor/rules/style.mdc)
Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.
Files:
CHANGELOG.mdREADME.md
🧠 Learnings (1)
README.md (1)
Learnt from: drew-u410
PR: #328
File: CONTRIBUTING.md:5-5
Timestamp: 2025-06-03T00:22:00.498Z
Learning: In the sourcebot repository CONTRIBUTING.md file, the maintainer prefers using "NodeJS" spelling instead of the official "Node.js" branding, and prefers not to add alt text to favicon images in the installation instructions.
🪛 markdownlint-cli2 (0.17.2)
README.md
60-60: Bare URL used
(MD034, no-bare-urls)
65-65: Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
README.md
[style] ~114-~114: In American English, abbreviations like “etc.” require a period.
Context: ...ndex your own repos, connect your LLMs, etc), check out our [docs](https://docs.sou...
(ETC_PERIOD)
⏰ 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: build
🔇 Additional comments (1)
CHANGELOG.md (1)
27-27: Changelog entry reads well – no action requiredThe new bullet succinctly captures the README update and follows the existing style.
README.md
Outdated
|
|
||
| You can try out our public hosted demo [here](https://demo.sourcebot.dev)! | ||
| https://github.com/user-attachments/assets/022f0bd0-db45-45ba-a31f-7bd43b6e2e25 |
There was a problem hiding this comment.
Maybe we can have two more sections here for code navigation and file browsing?
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
README.md (1)
124-124: Grammar nit: add period after “etc.”Insert the missing period inside the parentheses to satisfy LanguageTool and improve readability.
- (index your own repos, connect your LLMs, etc), + (index your own repos, connect your LLMs, etc.),
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
⛔ Files ignored due to path filters (1)
docs/images/code_nav.mp4is excluded by!**/*.mp4
📒 Files selected for processing (2)
README.md(3 hunks)docs/docs/overview.mdx(1 hunks)
✅ Files skipped from review due to trivial changes (1)
- docs/docs/overview.mdx
🧰 Additional context used
📓 Path-based instructions (1)
**/*
📄 CodeRabbit Inference Engine (.cursor/rules/style.mdc)
Filenames should always be camelCase. Exception: if there are filenames in the same directory with a format other than camelCase, use that format to keep things consistent.
Files:
README.md
🧠 Learnings (1)
README.md (1)
Learnt from: drew-u410
PR: #328
File: CONTRIBUTING.md:5-5
Timestamp: 2025-06-03T00:22:00.498Z
Learning: In the sourcebot repository CONTRIBUTING.md file, the maintainer prefers using "NodeJS" spelling instead of the official "Node.js" branding, and prefers not to add alt text to favicon images in the installation instructions.
🪛 markdownlint-cli2 (0.17.2)
README.md
60-60: Bare URL used
(MD034, no-bare-urls)
65-65: Bare URL used
(MD034, no-bare-urls)
70-70: Bare URL used
(MD034, no-bare-urls)
75-75: Bare URL used
(MD034, no-bare-urls)
🪛 LanguageTool
README.md
[style] ~124-~124: In American English, abbreviations like “etc.” require a period.
Context: ...ndex your own repos, connect your LLMs, etc), check out our [docs](https://docs.sou...
(ETC_PERIOD)
🔇 Additional comments (2)
README.md (2)
44-48: Remove redundant bullet list or relocate it to avoid duplication with the new Features sectionThe high-level bullets at Lines 44-46 overlap almost verbatim with the dedicated “Features” section that starts at Line 52. Keeping both inflates the README and forces maintainers to update two separate lists every time a feature description changes.
[tagged: suggest_optional_refactor]
79-80: Verify new docs path/docs/deployment-guideThe link changed from the top-level “Self-Hosting” page to
/docs/deployment-guide. Make sure this path actually exists in the published Docusaurus site; a 404 here would break the quick-start flow.
Summary by CodeRabbit