Improve readme #20

ahmedmawiri · 2025-11-18T17:08:47Z

Summary by CodeRabbit

Documentation
- Renamed and clarified top-level headings and introduction (including Arabic meaning for Sendook)
- Reorganized Quick Start into clear subsections: API Endpoints, TypeScript SDK, Self-hosting & Running Locally, Repository Structure, Features, SDKs, and License
- Expanded API examples with full headers and request payloads for inbox creation, message sending, and webhook setup

vercel · 2025-11-18T17:08:53Z

The latest updates on your projects. Learn more about Vercel for GitHub.

Project	Deployment	Preview	Comments	Updated (UTC)
sendook	Ready	Preview	Comment	Nov 18, 2025 5:13pm
sendook-app	Ready	Preview	Comment	Nov 18, 2025 5:13pm

coderabbitai · 2025-11-18T17:08:59Z

Caution

Review failed

The pull request is closed.

Walkthrough

README.md reorganized: headings renamed, Arabic meaning added, Quick Start refactored into new subsections, and API curl examples expanded with Authorization and Content-Type headers and fuller payloads.

Changes

Cohort / File(s)	Summary
Documentation `README.md`	Renamed section headings ("What is this?" → "What is Sendook?", etc.), added Arabic meaning for Sendook, introduced top-level "Quick Start" subsections (Using the API Endpoints, Using the TypeScript SDK, Self-hosting & Running Locally, Repository Structure, Features, SDKs, License), moved/reorganized "Using the API" content, and expanded curl API examples to include `Authorization` and `Content-Type` headers and full payloads for inbox creation, message sending, and webhook creation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~8 minutes

Documentation-only changes, straightforward reorganization.
Check: accuracy of renamed headings, consistency of subsection ordering, correctness of added header examples and JSON payloads.

Possibly related PRs

Readme improvements #9 — Overlapping README restructuring and expanded API example/header updates.

Suggested reviewers

marcrupt

Poem

🐰 I hopped through lines of README cheer,

New headings found and examples clear,
Arabic whispers tucked in the text,
Quick Start paths neatly indexed,
Sendook sings — docs polished, sincere. ✨

Pre-merge checks and finishing touches

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Title check	❓ Inconclusive	The title 'Improve readme' is vague and generic, lacking specificity about what aspect of the README was improved.	Use a more descriptive title that highlights the main improvement, such as 'Enhance README documentation with API examples and headers' or 'Update README with expanded Quick Start section and example payloads'.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

📜 Recent review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6c04486 and 51928cc.

📒 Files selected for processing (1)

README.md (3 hunks)

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

coderabbitai

Actionable comments posted: 1

🧹 Nitpick comments (1)

README.md (1)
16-16: Minor: Refine heading grammar.

The heading "Why is Sendook?" is slightly awkward. Consider changing it to "Why Sendook?" for more natural phrasing.
-## Why is Sendook?
+## Why Sendook?

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 595ee75 and 6c04486.

📒 Files selected for processing (1)

README.md (3 hunks)

🔇 Additional comments (1)

README.md (1)

12-14: Well-structured documentation improvements.

The documentation updates are comprehensive and well-organized:

Clearer heading titles ("What is Sendook?" is more descriptive)

Arabic etymology adds helpful context

Table of contents provides excellent navigation

API examples now include proper Authorization and Content-Type headers, which is essential for user clarity

Examples are consistent and demonstrate both inline code blocks and TypeScript SDK usage

Also applies to: 24-30, 34-72

coderabbitai · 2025-11-18T17:12:02Z

README.md

 ## Quick Start

-### Using the API
+- [Using the API Endpoints](#using-the-api-endpoints)
+- [Using the TypeScript SDK](#using-the-typescript-sdk)
+- [Self-hosting & Running Locally](#self-hosting--running-locally)
+- [Repository Structure](#repository-structure)
+- [Features](#features)
+- [SDKs](#sdks)
+- [License](#license)
+
+### Quick Start


⚠️ Potential issue | 🟡 Minor

Remove duplicate "Quick Start" heading to clarify structure.

Line 22 defines ## Quick Start, but line 32 redefines it as ### Quick Start. This creates a confusing heading hierarchy. The subsection heading at line 32 should be removed since the table of contents below it already serves as a guide to the Quick Start sections.

Apply this diff to remove the redundant heading:

## Quick Start - [Using the API Endpoints](#using-the-api-endpoints) - [Using the TypeScript SDK](#using-the-typescript-sdk) - [Self-hosting & Running Locally](#self-hosting--running-locally) - [Repository Structure](#repository-structure) - [Features](#features) - [SDKs](#sdks) - [License](#license) -### Quick Start - #### Using the API endpoints

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

## Quick Start

### Using the API

- [Using the API Endpoints](#using-the-api-endpoints)

- [Using the TypeScript SDK](#using-the-typescript-sdk)

- [Self-hosting & Running Locally](#self-hosting--running-locally)

- [Repository Structure](#repository-structure)

- [Features](#features)

- [SDKs](#sdks)

- [License](#license)

### Quick Start

## Quick Start

- [Using the API Endpoints](#using-the-api-endpoints)

- [Using the TypeScript SDK](#using-the-typescript-sdk)

- [Self-hosting & Running Locally](#self-hosting--running-locally)

- [Repository Structure](#repository-structure)

- [Features](#features)

- [SDKs](#sdks)

- [License](#license)

#### Using the API endpoints

🤖 Prompt for AI Agents

In README.md around lines 22 to 32, there's a duplicate heading: a top-level "## Quick Start" at line 22 and a redundant "### Quick Start" at line 32; remove the latter (line 32) so the table of contents remains under the single "## Quick Start" heading and the document heading hierarchy is consistent.

Improve readme

6c04486

ahmedmawiri requested a review from marcrupt November 18, 2025 17:08

vercel bot deployed to Preview – sendook-app November 18, 2025 17:09 View deployment

vercel bot deployed to Preview – sendook November 18, 2025 17:10 View deployment

grammar

51928cc

marcrupt approved these changes Nov 18, 2025

View reviewed changes

coderabbitai bot reviewed Nov 18, 2025

View reviewed changes

vercel bot deployed to Preview – sendook-app November 18, 2025 17:12 View deployment

ahmedmawiri merged commit 87240d8 into main Nov 18, 2025
2 of 4 checks passed

ahmedmawiri deleted the ahmed/readme-links branch November 18, 2025 17:12

vercel bot deployed to Preview – sendook November 18, 2025 17:13 View deployment

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Improve readme #20

Improve readme #20

Uh oh!

ahmedmawiri commented Nov 18, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

vercel bot commented Nov 18, 2025 •

edited

Loading

Uh oh!

coderabbitai bot commented Nov 18, 2025 •

edited

Loading

Review failed

Uh oh!

coderabbitai bot left a comment

Uh oh!

coderabbitai bot Nov 18, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Improve readme #20

Improve readme #20

Uh oh!

Conversation

ahmedmawiri commented Nov 18, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

vercel bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

coderabbitai bot commented Nov 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Review failed

Walkthrough

Changes

Estimated code review effort

Possibly related PRs

Suggested reviewers

Poem

Pre-merge checks and finishing touches

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

coderabbitai bot Nov 18, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

ahmedmawiri commented Nov 18, 2025 •

edited by coderabbitai bot

Loading

vercel bot commented Nov 18, 2025 •

edited

Loading

coderabbitai bot commented Nov 18, 2025 •

edited

Loading