doc: updated readme #414
doc: updated readme #414
Conversation
* structured the setup differently * added step by step instructions
* made it easier to read
|
@danielle-h is attempting to deploy a commit to the Inbox Zero Team on Vercel. A member of the Team first needs to authorize it. |
WalkthroughThe README.md file was extensively restructured and expanded to enhance clarity and detail regarding setup and configuration. Key sections were reorganized, with setup instructions moved earlier and contribution guidelines shifted to the end. New and detailed subsections were added for environment variables, external services, and premium features. Instructions for Google OAuth, LLM providers, Redis, and Postgres were clarified and expanded. Formatting and ordering improvements were made throughout the document to improve readability and accessibility. 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:
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 (10)
README.md (10)
25-25: Reevaluate early contribution note placement
The note on line 25 under "About" duplicates information later in the dedicated "Contributing to the project" section at the end. Consider removing or relocating this line to avoid confusing readers.
71-71: Remove leading spaces in headings
Markdown headings should start at the beginning of the line to satisfy MD023. Please remove the leading spaces before these headings:
- Line 71 (“### Setup”)
- Line 88 (“### Updating .env file: secrets”)
- Line 114 (“### Updating .env file with Google OAuth credentials:”)
- Line 276 (“### Contributing to the project”)
Also applies to: 88-88, 114-114, 276-276
73-73: Refine video link description
The setup video link is valuable. Consider rephrasing the sentence to match the doc’s style, for example:
“Watch the setup walkthrough for more details on external service configuration.”
79-79: Standardize product naming
Use the official product name Docker Desktop (capitalize both words) to match upstream documentation and avoid ambiguity.
81-81: Polish instructional tone
Replace “Make sure you have the above installed before starting” with a more direct style, e.g.:
“Ensure all required tools are installed before proceeding.”
83-86: Reorder and clarify external services
Great to see Google PubSub added. For better UX, consider:
- Grouping services by category (OAuth, Pub/Sub, Datastore).
- Ordering them alphabetically or indicating which are optional vs. required.
90-90: Trim paragraph indentation
The line “Create your own.envfile from the example supplied:” has an extra leading space. Remove it so the paragraph renders correctly.
102-103: Use consistent subheading style for variable groups
Currently “Secrets:” and “Redis:” are plain text. To enhance readability and support markdown linters, convert these into subheadings, e.g.:#### Secrets #### RedisAlso applies to: 107-108
114-118: Remove trailing colon and fix indentation
- The heading on line 114 ends with a colon (MD026); remove it.
- Eliminate the leading space before this heading.
- Ensure the bullets under it are not over‑indented for consistent rendering.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
114-114: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
122-139: Align list formatting and correct grammar in Google OAuth steps
There are a few minor list and grammar nits in the OAuth setup:
- Use consistent numbering for nested lists (avoid restarting at “1.” each time).
- Change “Copy paste” to “copy and paste” (line 143).
- Prevent duplicate list numbers (“5.” appears twice around lines 152–153).
- Prefer “Save on the Data Access page” instead of “in the Data Access page” (line 153).
- Indent nested list items by two spaces for proper markdown syntax.
Also applies to: 141-158
🧰 Tools
🪛 LanguageTool
[duplication] ~131-~131: Possible typo: you repeated a word.
Context: ...lient ID. 2. InApplication Type, ChooseWeb application3. Choose a name for your web client 4. In Au...(ENGLISH_WORD_REPEAT_RULE)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
README.md(5 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
README.md
88-88: Headings must start at the beginning of the line
null
(MD023, heading-start-left)
114-114: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🪛 LanguageTool
README.md
[duplication] ~131-~131: Possible typo: you repeated a word.
Context: ...lient ID. 2. In Application Type, Choose Web application 3. Choose a name for your web client 4. In Au...
(ENGLISH_WORD_REPEAT_RULE)
[grammar] ~143-~143: Did you mean “Copy and paste”?
Context: ... 2. Click Add or remove scopes 3. Copy paste the below into the `Manually add scopes...
(COPY_PASTE)
[duplication] ~152-~152: Possible typo: you repeated a word.
Context: ...apis.com/auth/contacts ``` 4. Click Update 5. Click `Save` in the Data Access page. 5. Add...
(ENGLISH_WORD_REPEAT_RULE)
[uncategorized] ~153-~153: The preposition “on” seems more likely in this position than the preposition “in”.
Context: ... 4. Click Update 5. Click Save in the Data Access page. 5. Add yourself ...
(AI_EN_LECTOR_REPLACEMENT_PREPOSITION_IN_ON)
[style] ~178-~178: You have already used this phrasing in nearby sentences. Consider replacing it to add variety to your writing.
Context: ...34/apias the base URL. You might also need to setOLLAMA_HOSTto0.0.0.0` in the O...
(REP_NEED_TO_VB)
🔇 Additional comments (3)
README.md (3)
159-168: Solid LLM provider list
The bullet list of LLM providers is clear and comprehensive. You might consider adding short descriptions or sample use‑cases for each, but otherwise this looks great.
173-176: Validate code snippet formatting
The Ollama setup code block is correctly formatted and ready for copy/paste. No changes needed here.
276-276: Confirm Contributing section relocation
Moving the "Contributing to the project" section to the end improves document flow and keeps setup instructions focused. LGTM!
|
Thanks for the PR! Will get to it soon! |
Summary by CodeRabbit