feat: updated installation guide in readme Implements #1360#1396
feat: updated installation guide in readme Implements #1360#1396Malayt04 wants to merge 2 commits intoMail-0:stagingfrom
Conversation
WalkthroughThe README.md file was thoroughly rewritten to enhance clarity and user guidance for local setup of the Zero project. The update restructures setup instructions, revises the logo and tagline, adds detailed environment variable explanations, and improves sections for external service configuration, contribution, and sponsor display. Changes
Possibly related PRs
Poem
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 (
|
![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 (6)
README.md (6)
4-4: Extract inline styles for maintainability
The<img>tag includes inline CSS which can be hard to update and may not render consistently across platforms. Consider simplifying the HTML or centralizing styling (e.g., via a CSS file or utility classes).
10-10: Remove trailing period in tagline
Headings and taglines typically omit terminal punctuation for cleaner presentation. You may want to drop the final.to match common markdown heading style.
44-47: Enforce consistent unordered-list style
Current list items use*but the repo’s markdown lint expects-.- * [Node.js](https://nodejs.org/en/) (v18 or later recommended) - * [pnpm](https://pnpm.io/installation) - * [Docker](https://www.docker.com/products/docker-desktop/) & Docker Compose + - [Node.js](https://nodejs.org/en/) (v18 or later recommended) + - [pnpm](https://pnpm.io/installation) + - [Docker](https://www.docker.com/products/docker-desktop/) & Docker Compose
117-118: Use GitHub-compatible warning syntax
The[!WARNING]block may not render on GitHub. Switch to a simple bold label:- > [!WARNING] - > This URI must match **exactly**. + > **Warning:** This URI must match **exactly**.
161-163: Remove duplicate translation guide entry
The translation guide link appears twice. Consider removing the second line to avoid redundancy:- Please refer to the [contributing guide](.github/CONTRIBUTING.md) and the [translation guide](.github/TRANSLATION.md). - If you'd like to help with translating Zero to other languages, check out our [translation guide](.github/TRANSLATION.md). + Please refer to the [contributing guide](.github/CONTRIBUTING.md) and the [translation guide](.github/TRANSLATION.md).
171-171: Reduce inline HTML for logo container
The<div style="...">wrapper uses inline flex styles. Markdown-level layouts (e.g.,<div align="center">or a simple table) are often more portable and easier to maintain.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
45-45: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
46-46: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
47-47: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (1)
README.md (1)
40-42: These new sections and command blocks are clear, well-structured, and follow the project's documentation conventions. No issues detected.Also applies to: 49-58, 60-65, 67-73, 75-82, 84-104, 105-116, 119-124, 125-129, 131-136, 137-143, 186-188
|
@Malayt04 you can also add about twilio, dont want to make another pr just for this, if you can update |
|
@rohhann12 Yeah makes sense. Will modify it |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
README.md (2)
45-47: Unify list markers for consistency.Switch asterisk bullets to dashes to match the existing list style:
- * [Node.js](https://nodejs.org/en/) (v18 or later recommended) - * [pnpm](https://pnpm.io/installation) - * [Docker](https://www.docker.com/products/docker-desktop/) & Docker Compose + - [Node.js](https://nodejs.org/en/) (v18 or later recommended) + - [pnpm](https://pnpm.io/installation) + - [Docker](https://www.docker.com/products/docker-desktop/) & Docker Compose
168-170: Remove duplicated translation guide link.The translation guide is mentioned twice. Consider removing one occurrence to avoid redundancy:
- If you'd like to help with translating Zero to other languages, check out our [translation guide](.github/TRANSLATION.md).
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(4 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
45-45: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
46-46: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
47-47: Unordered list style
Expected: dash; Actual: asterisk
(MD004, ul-style)
🔇 Additional comments (6)
README.md (6)
4-4: Logo styling enhancement approved.The updated
<img>tag includes padding and border-radius for improved visual appearance.
10-10: Updated tagline approved.The new tagline is punctuated and clear.
40-40: New welcome message approved.The introductory line clearly guides contributors.
101-104: Twilio environment variables added.Including
TWILIO_ACCOUNT_SID,TWILIO_AUTH_TOKEN, andTWILIO_PHONE_NUMBERensures SMS support is documented.
125-131: Twilio setup instructions approved.The step-by-step guide for configuring Twilio credentials is clear and comprehensive.
178-178: Sponsor logos layout improvement approved.Adding
gapand vertical alignment enhances the sponsor section's appearance.
There was a problem hiding this comment.
@Malayt04
There are some environment variables that are not required. Even if we set them with random values, the local setup still works (for example: Microsoft-related env variables).
It would be helpful to mention which variables are required and which ones are optional.
Also, some users are facing conflicts between the Redis container in Docker and their own local Redis installation.
For example, some contributors already have Redis installed on their system, which causes issues when running Docker.
It would be great to also add steps to set up the project without Docker, like installing PostgreSQL and Redis locally.
cc: @MrgSub
|
@aialok only the env vars that are necessary for running the project locally are mentioned in the table. Will surely write about the installation without docker. Thanks for the feedback. |
|
|
||
| ```bash | ||
| # Replace [YOUR_USERNAME] with your GitHub username. | ||
| git clone https://github.com/[YOUR_USERNAME]/Zero.git |
|
This PR removes a lot of good parts of the current README |
4 participants
In this update
Summary by CodeRabbit