docs: improve README, fix links and capitalization.md #1
Conversation
WalkthroughREADME.md updated to point badges, links, image, and Quick Start clone/directory to the OpenVoiceX/DialogWeaver repository; content rebranded and expanded (Key Features, Architecture, deployment instructions); trailing newline(s) added after the License block. No public API changes. Changes
Tip 🔌 Remote MCP (Model Context Protocol) integration is now available!Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats. 📜 Recent review detailsConfiguration used: CodeRabbit UI 💡 Knowledge Base configuration:
You can enable these sources in your CodeRabbit configuration. 📒 Files selected for processing (1)
🚧 Files skipped from review as they are similar to previous changes (1)
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. CodeRabbit Commands (Invoked using PR/Issue comments)Type Other keywords and placeholders
CodeRabbit Configuration File (
|
![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
🧹 Nitpick comments (2)
README.md (2)
12-16: Fix issues badge image URL (still points to placeholder repo)The anchor href points to the correct repo, but the shield image still references your-username/dialogweaver, so the badge count will be wrong.
Apply this diff to correct the shield:
- <a href="https://github.com/Hiteshydv001/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/your-username/dialogweaver" alt="GitHub issues"></a> + <a href="https://github.com/Hiteshydv001/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/Hiteshydv001/DialogWeaver" alt="GitHub issues"></a>
12-16: Potential mismatch: Contribution doc link vs later CONTRIBUTING.mdThis header links to docs/Contribution.md, while later you reference CONTRIBUTING.md (root). One of these is likely incorrect.
If CONTRIBUTING.md in repo root is the canonical guide, align this link:
- <a href="https://github.com/Hiteshydv001/DialogWeaver/blob/main/docs/Contribution.md"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen.svg" alt="PRs Welcome"></a> + <a href="https://github.com/Hiteshydv001/DialogWeaver/blob/main/CONTRIBUTING.md"><img src="https://img.shields.io/badge/PRs-Welcome-brightgreen.svg" alt="PRs Welcome"></a>Otherwise, update the later references to match docs/Contribution.md. Please verify which path actually exists in the main repo.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(3 hunks)
🔇 Additional comments (2)
README.md (2)
12-12: License badge link fix looks goodLinking the badge directly to the repo’s LICENSE file is correct.
104-104: Trailing newline addition is fineMinor formatting improvement; no further action needed.
|
I have changed it. Can you please check it now? |
|
@Sejal-hani change all hitesh mention to openvoicex in readme properly test all links before putting |
|
Okay 👍 |
There was a problem hiding this comment.
Actionable comments posted: 0
🔭 Outside diff range comments (1)
README.md (1)
2-2: Mandatory: Replace all legacy “Hitesh” references with “OpenVoiceX” across the docsI found several remaining references to the old username and project path. Please update the following:
• README.md (line 2):
- <img src="https://github.com/Hiteshydv001/DialogWeaver/blob/main/docs/logo.jpg" …> + <img src="https://github.com/OpenVoiceX/DialogWeaver/blob/main/docs/logo.jpg" …>• LICENSE (line 3):
- Copyright (c) 2024 Hitesh Yadav + Copyright (c) 2024 OpenVoiceX contributors• CONTRIBUTING.md:
– Badges (lines 13–15): update allhttps://github.com/Hiteshydv001/DialogWeaver→https://github.com/OpenVoiceX/DialogWeaver
– Clone instructions (lines 74–76):- git clone https://github.com/Hiteshydv001/DialogWeaver.git + git clone https://github.com/OpenVoiceX/DialogWeaver.git– Issue links (lines 177–178): point to
OpenVoiceX/DialogWeaver/issues
– PR instructions (line 195): change target repo toOpenVoiceX/DialogWeaverAfter these updates, rerun a search for “Hitesh” or “Hiteshydv001” to ensure no remnants remain.
🧹 Nitpick comments (3)
README.md (3)
13-13: Fix issues badge image source to target OpenVoiceX/DialogWeaverHref is correct, but the badge image still references the placeholder repo, which will show the wrong count.
Apply this diff to fix the badge image source:
- <a href="https://github.com/OpenVoiceX/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/your-username/dialogweaver" alt="GitHub issues"></a> + <a href="https://github.com/OpenVoiceX/DialogWeaver/issues"><img src="https://img.shields.io/github/issues/OpenVoiceX/DialogWeaver" alt="GitHub issues"></a>
39-39: Capitalize “No-Code Agent Builder” for consistencyThe features section capitalizes “No-Code UI Playground”. Consider mirroring that style here.
-| **`ui`** | User-facing dashboard and no-code agent builder. | `Next.js`, `React`, `TypeScript`, `Tailwind CSS` | +| **`ui`** | User-facing dashboard and No-Code Agent Builder. | `Next.js`, `React`, `TypeScript`, `Tailwind CSS` |
15-15: Replace Discord placeholder link when availableThe Discord badge href is “#”. If a community server exists, link the invite to improve onboarding.
- <a href="#"><img src="https://img.shields.io/static/v1?label=Discord&message=Join%20Chat&color=7289DA&logo=discord" alt="Join the community on Discord"></a> + <a href="https://discord.gg/REPLACE_WITH_INVITE"><img src="https://img.shields.io/static/v1?label=Discord&message=Join%20Chat&color=7289DA&logo=discord" alt="Join the community on Discord"></a>
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(4 hunks)
🔇 Additional comments (5)
README.md (5)
12-12: License badge link corrected — LGTMHref now points to OpenVoiceX/DialogWeaver LICENSE. Good catch.
14-14: PRs Welcome badge link updated — LGTMPoints to CONTRIBUTING.md in the OpenVoiceX repo. Looks good.
45-45: Architecture diagram link updated — LGTMImage now references OpenVoiceX/DialogWeaver. All good.
60-61: Quick Start clone path corrected — LGTMClone URL and cd target now match the canonical repo and directory casing.
104-107: EOF newlines — OKEnd-of-file newlines added. No functional impact; acceptable style-wise.
|
I have changed the links. The discord link is not working though. If there, kindly share it. |
|
No there is no discord as of now for contributors |
|
Remove it either |
Removed discord icon from links below headings.
|
Done. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (3)
README.md (3)
45-45: Prefer relative path for the architecture diagram for portability.Using a relative path ensures the image renders across forks/branches and in non-GitHub renderers.
- +
2-2: Update logo image source to OpenVoiceX (or use relative path).There’s still a reference to
Hiteshydv001here. For consistency with the rest of the README and org rebrand, switch to a relative path (preferred) or to the OpenVoiceX repo URL.- <img src="https://github.com/Hiteshydv001/DialogWeaver/blob/main/docs/logo.jpg" alt="DialogWeaver Logo" width="400"> + <img src="docs/logo.jpg" alt="DialogWeaver Logo" width="400">
104-108: Trim excessive trailing blank lines.A single trailing newline is sufficient; multiple blank lines at EOF add noise in diffs.
- - - - -
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
💡 Knowledge Base configuration:
- MCP integration is disabled by default for public repositories
- Jira integration is disabled by default for public repositories
- Linear integration is disabled by default for public repositories
You can enable these sources in your CodeRabbit configuration.
📒 Files selected for processing (1)
README.md(4 hunks)
🔇 Additional comments (3)
README.md (3)
12-12: Badges: LGTM.
- License badge href updated correctly.
- PRs Welcome badge points to CONTRIBUTING.md correctly.
Also applies to: 14-14
60-61: Quick Start clone/CD: LGTM.Clone URL and directory name now consistently use OpenVoiceX/DialogWeaver.
11-15: All external links in README.md resolve successfullyThe only apparent failure (
https://github.com/OpenVoiceX/DialogWeaver.git) was caused by a stray carriage return at the end of the URL. After trimming that, it returns HTTP 200. No broken links remain.Optional cleanup:
- Normalize line endings in README.md (e.g. run
dos2unix README.md) to remove stray\rcharacters around URLs.[optional_refactors_recommended]
|
@Sejal-hani thnaks for your valueable contribution |
|
@Sejal-hani kindly provide your mail id for points assignment |
|
3 participants
This PR fixes several small issues in the README.md file, including incorrect repository links, and a typo in a code block:
Corrected Typo & Capitalization: Fixed inconsistent capitalization of "no-code UI playground" to match the "No-Code Agent Builder" heading.
Updated Links: Corrected the URLs for the license and issues badges to point to the main repository, Hiteshydv001/DialogWeaver, instead of your-username/dialogweaver.
Resolved Code Block Typo: Changed the git clone command in the "Quick Start" section to use the correct repository name, DialogWeaver, instead of dialogweaver.
Summary by CodeRabbit