Updated install docs

[marcrupt]

Summary by CodeRabbit

• Documentation
  • Updated registration endpoint and sign-up link to the new /register URL
  • Simplified Node.js setup and consolidated verification snippet
  • Removed Python and Go installation guides
  • Modified environment requirements: added AWS credential vars and DEFAULT_EMAIL_DOMAIN; removed SMTP, JWT and webhook-related settings
  • Updated DNS guidance with provider-specific MX/DMARC entries
  • Added first_name and last_name to the registration flow

[vercel]

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

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

[coderabbitai]

Walkthrough

Documentation for installation was revised: signup/register endpoints and request fields changed, Python/Go SDK install and language-specific verification snippets removed, Node.js-only verification added, environment variables and DNS/Docker references updated, and AWS credentials introduced.

Changes

Cohort / File(s)

Change Summary

Documentation update landing/content/1.docs/1.getting-started/2.installation.md

Replaced /signup with /register (endpoint now /auth/register) and added first_name/last_name fields; removed Python and Go SDK installation and language-specific verification snippets; consolidated verification to a Node.js example; removed EMAIL_DOMAIN, JWT_SECRET, SMTP and webhook-related env/docs entries; added DEFAULT_EMAIL_DOMAIN, AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY; replaced generic SMTP/SPF/DKIM DNS guidance with provider-specific MX and DMARC entries; removed SMTP receiver and webhook worker from Docker Compose list; various related text updates.

Sequence Diagram(s)

sequenceDiagram
  autonumber
  participant User
  participant ClientDocs as "Client (docs)"
  participant API as "Auth API"
  participant NodeVerify as "Node verification example"

  rect rgba(100,150,255,0.06)
    Note over ClientDocs,API: Old flow (before)
    User->>ClientDocs: Reads /signup docs
    ClientDocs-->>API: Instructs POST /api/v1/auth/signup (orgName)
    ClientDocs-->>User: Shows multiple SDK verification snippets (Python, Node, Go)
  end

  rect rgba(100,255,150,0.06)
    Note over ClientDocs,API: New flow (after)
    User->>ClientDocs: Reads /register docs
    ClientDocs-->>API: Instructs POST /auth/register (first_name, last_name)
    ClientDocs-->>NodeVerify: Shows single Node.js verification snippet (instantiate with key)
    NodeVerify-->>API: Verifies API key via Node.js example
  end

Loading

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

• Single documentation file changed; mostly textual/config updates.
• Review focus:
  • Confirm endpoint and field name replacements (/api/v1/auth/signup → /auth/register, organizationName → removed, first_name/last_name added).
  • Verify removal of Python/Go blocks and correctness of consolidated Node.js verification snippet.
  • Validate environment variable table updates and DNS/Docker references for accuracy.

Poem

🐰 I hopped through lines of docs so bright,
New register paths and keys in sight,
Python and Go took a graceful bow,
Node now verifies — hip-hop, meow! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title 'Updated install docs' accurately summarizes the main change—updates to the installation documentation file. It is concise, clear, and directly reflects the changeset which consists entirely of modifications to the installation guide.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✨ Finishing touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch marc/updated-install-instructions

Tip

📝 Customizable high-level summaries are now available!

You can now customize how CodeRabbit generates the high-level summary in your pull requests — including its content, structure, tone, and formatting.

• Provide custom instructions to shape the summary (bullet lists, tables, contributor stats, etc.).
• Use high_level_summary_in_walkthrough to move the summary from the description to the walkthrough section.

Example:

"Create a concise high-level summary as a bullet-point list. Then include a Markdown table showing lines added and removed by each contributing author."

---

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

[ahmedmawiri]

The one comment I have is because if we don't put the right AWS DNS records, it will reject and email receiving will not work.

[ahmedmawiri]

Should this be AWS coz we operate in AWS zone right now?

[coderabbitai]

Actionable comments posted: 1

🧹 Nitpick comments (1)

landing/content/1.docs/1.getting-started/2.installation.md (1)

41-45: Verification snippet only demonstrates instantiation, not actual connectivity or functionality.

The code snippet instantiates the Sendook client but doesn't test that the setup actually works. Consider adding a minimal example that sends a test email or queries the API to verify the key is valid.

For example:

const sendook = new Sendook(process.env.SENDOOK_API_KEY);
// Test: create a test inbox or send a test email
const inbox = await sendook.inboxes.create({ domain: "test.yourdomain.com" });
console.log("Setup successful! Inbox:", inbox.id);

This gives users confidence the setup is working before proceeding.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 6e93ef1 and 6935602.

📒 Files selected for processing (1)

• landing/content/1.docs/1.getting-started/2.installation.md (6 hunks)

🔇 Additional comments (1)

landing/content/1.docs/1.getting-started/2.installation.md (1)

81-82: Confirm AWS is the intended sole email provider or document alternatives.

The updated documentation now requires AWS credentials (AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY) for self-hosted deployments. This represents a significant change from the previous setup. Verify that:

1. AWS SES is the only supported email provider for self-hosted deployments, or
2. If other providers are supported, document them as alternatives with their respective credential requirements.

Also consider linking to AWS IAM setup documentation for users unfamiliar with obtaining these credentials.

[coderabbitai]

🛠️ Refactor suggestion | 🟠 Major

Add security guidance for .env file handling.

While the AWS credentials shown are placeholders, documentation should explicitly warn users not to commit .env files to version control and recommend adding .env to .gitignore. Even placeholder values in documentation could mislead users into thinking it's safe to include real credentials in docs or commit them.

Consider adding a note like:

⚠️ **Important:** Never commit `.env` to version control. Add it to `.gitignore`:
echo ".env" >> .gitignore

🤖 Prompt for AI Agents

In landing/content/1.docs/1.getting-started/2.installation.md around lines 78 to
83, add a clear security note warning users not to commit .env files to version
control and instruct them to add .env to .gitignore; include a short admonition
phrased like "Important: Never commit .env to version control" and a one-line
command suggestion to append .env to .gitignore so readers know how to protect
credentials.