Update readme #119
Update readme #119
Conversation
…plura into feature/contributing-md
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
@osh0612 is attempting to deploy a commit to the BlueFinZ Team on Vercel. A member of the Team first needs to authorize it. |
|
Caution Review failedThe pull request is closed. WalkthroughThe pull request introduces a comprehensive rebranding of the project from a Turborepo starter to "Plura," an AI-powered communication platform. The Changes
Possibly related PRs
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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 (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
README.md (1)
93-93: Consider updating Node.js version requirementThe requirement of Node.js v19+ seems unusually high. Most Next.js 14 applications work well with Node.js v18 (LTS).
Consider updating to
Node.js (v18+)unless there's a specific requirement for v19+.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
README.md(1 hunks)apps/www/README.md(0 hunks)
💤 Files with no reviewable changes (1)
- apps/www/README.md
🧰 Additional context used
🪛 LanguageTool
README.md
[uncategorized] ~24-~24: Loose punctuation mark.
Context: ...packages and applications: - apps/web: Main Plura web application - `apps/docs...
(UNLIKELY_OPENING_PUNCTUATION)
🪛 Markdownlint (0.37.0)
README.md
181-181: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
🔇 Additional comments (2)
README.md (2)
52-64: LGTM! Well-structured architecture diagram
The mermaid diagram effectively illustrates the system architecture and component relationships.
3-3: Verify the logo file path
Let's ensure the logo file exists at the specified path.
✅ Verification successful
Logo file path is correctly referenced
The logo file exists at the specified path /apps/www/public/images/plura-logo.png, confirming that the image reference in the README.md is valid and accurate.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the logo file exists
fd -t f "plura-logo.png" -p "apps/www/public/images"
Length of output: 88
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
README.md (6)
9-10: Consider removing redundant sectionSince both "What's inside?" and "System Architecture" sections are marked as coming soon, consider consolidating them into a single "Architecture" section to avoid redundancy.
13-17: Improve feature list formatting consistencyThe feature list has inconsistent spacing and emoji placement. Consider standardizing the format.
-🔗**Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more -🧠**Custom AI Training**: Easily teach your AI agents with specific, information -💬 **Chat with Collections**: Interact with specific knowledge bases. -🔍 **Powerful Search**: Quickly find any saved information. -🏠 **Self Hostable**: Open source and easy to deploy locally. +🔗 **Multi-Channel Connectivity**: Connect agents to websites, WhatsApp, Discord, Instagram, and more +🧠 **Custom AI Training**: Easily teach your AI agents with specific information +💬 **Chat with Collections**: Interact with specific knowledge bases +🔍 **Powerful Search**: Quickly find any saved information +🏠 **Self Hostable**: Open source and easy to deploy locally
26-28: Consider adding alt text and fallback for tech stack visualizationThe tech stack visualization depends on an external service which might not always be available. Consider:
- Adding alt text for accessibility
- Including a markdown table as a fallback
<div align="center"> -<img src="https://tech-orbit.wontory.dev/api?title=&tech=Vercel,Next.js,Tailwind%20CSS,Node.js,GraphQL,PostgreSQL,Redis,Turborepo,TypeScript,React,Prisma&size=1350&duration=15" alt="Plura" width="400"> +<img src="https://tech-orbit.wontory.dev/api?title=&tech=Vercel,Next.js,Tailwind%20CSS,Node.js,GraphQL,PostgreSQL,Redis,Turborepo,TypeScript,React,Prisma&size=1350&duration=15" + alt="Tech Stack: Vercel, Next.js, Tailwind CSS, Node.js, GraphQL, PostgreSQL, Redis, Turborepo, TypeScript, React, Prisma" + width="400"> </div> +<!-- Fallback tech stack table in case the image fails to load --> +| Category | Technologies | +|----------|-------------| +| Frontend | Next.js, React, Tailwind CSS | +| Backend | Node.js, GraphQL | +| Database | PostgreSQL, Redis | +| ORM | Prisma | +| Tools | Turborepo, TypeScript | +| Deployment | Vercel |
48-48: Consider adding Discord server ID to the invite linkThe Discord link could be more specific by including the server ID.
-Discord: [Discord](https://discord.gg/plura) +Discord: [Join our Discord server](https://discord.gg/plura)
53-55: Add alt text to contributor imageThe contributor visualization image is missing alt text for accessibility.
<a href="https://github.com/SkidGod4444/plura/graphs/contributors"> - <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" /> + <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" alt="Plura project contributors" /> </a>🧰 Tools
🪛 Markdownlint (0.37.0)
54-54: null
Images should have alternate text (alt text)(MD045, no-alt-text)
57-57: Convert emphasis to proper headingThe closing statement should use heading syntax instead of emphasis.
-**Engineered with ❤️ by the Plura Team** +### Engineered with ❤️ by the Plura Team🧰 Tools
🪛 Markdownlint (0.37.0)
57-57: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
README.md
57-57: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
54-54: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (3)
README.md (3)
7-7: LGTM! Clear and informative project description
The description effectively communicates the platform's purpose and main value proposition.
3-3: Verify the logo file exists
Let's ensure the logo file exists at the specified path.
✅ Verification successful
Logo file exists at the specified path
The image file plura-logo.png is present at the correct location /apps/www/public/images/plura-logo.png, making the image reference in the README.md valid.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the logo file exists
fd -t f "plura-logo.png" "apps/www/public/images/"
Length of output: 86
37-38: Verify Contributing.md file exists
Let's ensure the contributing guidelines file exists at the specified path.
✅ Verification successful
Contributing.md file exists and is properly populated
The CONTRIBUTING.md file exists at the root of the repository and contains comprehensive guidelines including setup instructions, pull request process, and code of conduct. The link in the README.md is valid and points to the correct file.
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash
# Check if the CONTRIBUTING.md file exists
fd -t f "^CONTRIBUTING.md$" -i
Length of output: 48
Script:
#!/bin/bash
# Let's verify the content of CONTRIBUTING.md to ensure it's properly populated
cat CONTRIBUTING.md
Length of output: 3190
There was a problem hiding this comment.
Actionable comments posted: 4
🔭 Outside diff range comments (1)
apps/www/README.md (1)
Environment variables and URLs need to be updated
The verification reveals inconsistencies in the environment setup documentation:
- The schema requires an additional
DIRECT_DATABASE_URLthat's not documented in the README- The codebase consistently uses ports 3001 (API) and 3003 (WWW) across multiple files, but these ports aren't documented in the environment setup section
- All environment variables in the README template are actively used in the codebase:
SUPABASE_URLandSUPABASE_KEYinapps/triggers/src/db.status.tsDATABASE_URLin Prisma schemaUPSTASH_REDIS_REST_TOKENandUPSTASH_REDIS_REST_URLinpackages/cache/src/index.tsPlease update the README to:
- Add the missing
DIRECT_DATABASE_URLvariable- Document the development server ports (3001 for API and 3003 for WWW)
🔗 Analysis chain
Line range hint
1-24: Verify environment variables and URLsPlease verify:
- The Supabase and Upstash configuration examples
- The localhost URLs (3001 and 3003)
🏁 Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Check if these ports are referenced in the codebase echo "Checking for port 3001 and 3003 references..." rg -n "3001|3003" # Check for environment variable usage echo "Checking for environment variable references..." rg "SUPABASE_|UPSTASH_|DATABASE_URL"Length of output: 2518
🧰 Tools
🪛 Markdownlint (0.37.0)
47-47: Expected: 3; Actual: 4
Inconsistent indentation for list items at the same level(MD005, list-indent)
47-47: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
61-61: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
58-58: null
Images should have alternate text (alt text)(MD045, no-alt-text)
🧹 Nitpick comments (7)
apps/www/README.md (1)
49-61: Improve formatting and accessibility of the Contact sectionThe Contact section needs some improvements:
- Add a line break after the "Contact" heading
- Add alt text to the contributors image for accessibility
Apply these changes:
## 📞 Contact - Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) - Discord: [Discord](https://discord.gg/plura) --- ### Contributing <a href="https://github.com/SkidGod4444/plura/graphs/contributors"> - <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" /> + <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" alt="Plura contributors" /> </a>🧰 Tools
🪛 Markdownlint (0.37.0)
61-61: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
58-58: null
Images should have alternate text (alt text)(MD045, no-alt-text)
README.md (1)
1-3: Add alt text to the Plura logoThe logo image needs alt text for accessibility.
# Plura - +CONTRIBUTING.md (3)
5-6: Fix grammar and clarity in contribution instructionsThe initial instructions need grammatical improvements and better clarity.
-When contributing to this repository, please first search throught the issues in the repository and commit "assign me" if you wish to work on that , -then owners of this repository will let you know by latest by assigning you the issue. +When contributing to this repository, please first search through the existing issues. Comment "assign me" on the issue you wish to work on. +Repository owners will respond by assigning the issue to you.
43-44: Improve clarity in the Responsibilities sectionThe responsibilities section needs grammatical improvements and better clarity.
-Project owners are responsible for taking care of the repository and guiding you -to the right way. So please follow to what they say and do in there command +Project owners are responsible for maintaining the repository and providing guidance. +Please follow their instructions and recommendations.
1-1: Add alt text to imagesBoth the logo and contributors images need alt text for accessibility.
- + <a href="https://github.com/SkidGod4444/plura/graphs/contributors"> - <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" /> + <img src="https://contrib.rocks/image?repo=SkidGod4444/plura" alt="Plura contributors" /> </a>Also applies to: 60-62
apps/api/README.md (2)
Line range hint
14-49: Add security notes for environment variablesWhile the environment variables are well documented, consider adding security notes about:
- Using strong, unique secrets for
BETTER_AUTH_SECRET- Implementing proper access controls for OAuth credentials
- Securing database and Redis connection strings
# Required: Authentication configuration BETTER_AUTH_SECRET= # Use a strong, unique secret (min 32 characters) BETTER_AUTH_URL= # Optional: OAuth provider credentials # For Google OAuth (https://console.cloud.google.com) # Note: Restrict OAuth credentials to specific origins and redirect URIs GOOGLE_CLIENT_ID= GOOGLE_CLIENT_SECRET=🧰 Tools
🪛 Markdownlint (0.37.0)
66-66: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
63-63: null
Images should have alternate text (alt text)(MD045, no-alt-text)
66-66: Use proper heading syntax instead of emphasisConvert the emphasized text to a proper heading for better document structure.
-**Engineered with ❤️ by the Plura Team** +### Engineered with ❤️ by the Plura Team🧰 Tools
🪛 Markdownlint (0.37.0)
66-66: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (4)
CONTRIBUTING.md(2 hunks)README.md(1 hunks)apps/api/README.md(1 hunks)apps/www/README.md(1 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
61-61: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
README.md
54-54: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
51-51: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
apps/api/README.md
66-66: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
63-63: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
apps/www/README.md
61-61: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
58-58: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
There was a problem hiding this comment.
Actionable comments posted: 4
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
64-64: Use proper heading instead of emphasisConvert the emphasized text to a proper heading for better document structure.
-**Engineered with ❤️ by the Plura Team** +### Engineered with ❤️ by the Plura Team🧰 Tools
🪛 Markdownlint (0.37.0)
64-64: null
Emphasis used instead of a heading(MD036, no-emphasis-as-heading)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
64-64: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
61-61: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (1)
CONTRIBUTING.md (1)
55-55: Update Discord link to use an actual invite URL
The current Discord link is generic and may not work. Please use an actual Discord invite URL.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
56-59: Consider adding context to contact channelsWhile the links are properly formatted, consider adding brief descriptions of when to use each channel (e.g., GitHub for issues/PRs, Discord for community discussions).
## 📞 Contact -Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) -Discord: [Discord](https://discord.gg/plura) +Project Link: [GitHub Repository](https://github.com/Skidgod4444/plura) - For issues, PRs, and code contributions +Community: [Discord](https://discord.gg/plura) - For discussions, questions, and community support
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 Markdownlint (0.37.0)
CONTRIBUTING.md
68-68: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
65-65: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
🔇 Additional comments (5)
CONTRIBUTING.md (5)
1-1: Use relative path for logo image
The previous review comment about using relative paths for the logo image remains valid.
5-6: Improve clarity and grammar in contribution instructions
The previous review comment about improving the clarity and grammar of the contribution instructions remains valid.
43-48: LGTM! Clear and well-structured responsibilities section
The maintainer responsibilities are clearly defined and well-organized.
64-66: Add alt text to contributor graph image
The previous review comment about adding alt text to the contributors graph image remains valid.
🧰 Tools
🪛 Markdownlint (0.37.0)
65-65: null
Images should have alternate text (alt text)
(MD045, no-alt-text)
68-68: LGTM! Appropriate closing message
The styling of the closing message adds a nice personal touch to the document.
🧰 Tools
🪛 Markdownlint (0.37.0)
68-68: null
Emphasis used instead of a heading
(MD036, no-emphasis-as-heading)
core: relevant changes
Summary by CodeRabbit
New Features
Documentation