docs: add usage overview for backend functions

[Khan30-ai]

This PR improves the root README by adding a concise usage overview for backend functions.

Changes include:
i) Added trigger type (HTTP / cron / webhook / event) for each major function
ii) Added high level input and output summaries without duplicating function level documentation
iii) Added direct links to the corresponding function folders for easier navigation
iv) Annotated a referenced function that currently has no implementation

All changes are documentation only and do not affect backend logic or runtime behavior.

Closes #132

Summary by CodeRabbit

• Documentation
  • Reorganized the Functions reference into clear, per-function sections with standardized headings (Trigger, Description, Input, Output, Authorization, Implementation).
  • Expanded and clarified several function entries (e.g., create/delete/join flows, webhook handling, OTP and email verification) and flagged one planned checker as not yet implemented.

_{✏️ Tip: You can customize this high-level summary in your review settings.}

[coderabbitai]

📝 Walkthrough

Walkthrough

The README Functions section was restructured into dedicated, consistently formatted entries for each backend function (Create Room, Delete Room, Join Room, Livekit Webhook Receiver, Match Maker, Send OTP, Verify OTP, Verify Email, Discussion Is-Time Checker, Database Cleaner), adding Trigger, Input, Output, Authorization, and Implementation fields.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Rewrote and expanded the Functions section into per-function subsections. Added standardized fields for each function (Trigger, Description, Input, Output, Authorization, Implementation) and linked implementation paths (e.g., functions/...). Clarified behaviors, inputs/outputs, and scheduling/webhook triggers where applicable.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Poem

🐰 I hopped through lines of README bright,
I carved each function into tidy light,
Triggers and inputs now dance in a row,
Paths to the code where curious devs go,
A tiny hop for docs, a helpful bite.

Pre-merge checks

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The PR title 'docs: add usage overview for backend functions' accurately summarizes the main change: documentation-only updates to the README Functions section with usage details.
Linked Issues check	✅ Passed	The PR implements most objectives from issue #132: documented trigger types, input/output summaries, and direct links to function folders for all 10 main functions in the restructured README Functions section.
Out of Scope Changes check	✅ Passed	All changes are scoped to README.md documentation as specified. The pull request includes a commit message about aligning database-cleaner cron schedule with appwrite.json, which reflects inline documentation consistency rather than out-of-scope functionality changes.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

---

📜 Recent review details

Configuration used: defaults

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a5e08f6 and 7d5c3f3.

📒 Files selected for processing (1)

• README.md

🔇 Additional comments (3)

README.md (3)

196-197: ✅ Cron schedule correction confirmed.

The Database Cleaner section now correctly documents the 04:00 UTC schedule with a reference to appwrite.json, addressing the previous discrepancy.

---

178-191: ✅ Unimplemented function clearly annotated.

Discussion Is-Time Checker is properly documented as a referenced but unimplemented feature, avoiding broken links while keeping contributors informed of its planned/deprecated status.

---

24-211: ✅ Documentation restructure successfully implements PR objectives.

The Functions section has been consistently restructured with clear, standardized entries for all 10 backend functions. Each entry includes trigger type, high-level input/output summaries, implementation links, and relevant context (authorization, cron schedules, behavior notes). The approach prevents documentation drift by keeping entries concise and cross-referencing authoritative sources like appwrite.json.

Key accomplishments:

• ✓ Trigger types documented (HTTP, Cron, Webhook, Event)
• ✓ Input/output summaries without function-level duplication
• ✓ Implementation folder links consistent and accessible
• ✓ Unimplemented function (Discussion Is-Time Checker) clearly marked
• ✓ Cron schedule corrected (04:00 UTC) and sourced to appwrite.json

The documentation provides good onboarding value for contributors without requiring code navigation.

---

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.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

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

[coderabbitai]

Actionable comments posted: 2

Fix all issues with AI Agents 🤖

In @README.md:
- Around line 196-197: README incorrectly states the Database Cleaner runs daily
at 01:00; the actual cron in appwrite.json is "0 4 * * *" (04:00 UTC). Update
the README lines describing the schedule (the block containing "**Schedule:**"
and the "Runs daily at 01:00" text) to reflect "Runs daily at 04:00 (configured
via cron)" or otherwise cite 04:00 UTC to match the appwrite.json cron entry.

🧹 Nitpick comments (3)

README.md (3)

39-39: Consider converting implementation paths to markdown links for better navigation.

The implementation paths (e.g., functions/create-room/) are currently plain text. Converting them to clickable markdown links would improve discoverability and reduce friction for contributors exploring the codebase.

🔎 Example refactor

**Implementation:**  
-`functions/create-room/`
+[`functions/create-room/`](functions/create-room/)

Apply this pattern to all 9 implemented functions (lines 39, 60, 78, 99, 118, 137, 157, 175, 210).

Also applies to: 60-60, 78-78, 99-99, 118-118, 137-137, 157-157, 175-175, 210-210

---

178-189: Good documentation of unimplemented function; consider clarifying planned status.

The Discussion Is-Time Checker is properly annotated with a Status section noting the lack of implementation. However, the "Trigger: Cron (Planned)" label could be clarified—does "Planned" indicate the function is on the roadmap but not yet started, or is it a low-priority item? A brief timeline or issue reference would help contributors understand the priority and context.

---

121-137: Optional: Consider adding minimal curl examples for core functions.

The PR objectives mention optional curl examples for 2–3 core functions (create-room, join-room, send-otp) to demonstrate local/dev invocation. While optional and not critical, such examples would significantly improve onboarding for contributors unfamiliar with Appwrite function invocation patterns.

🔎 Example curl documentation for Send OTP

**Example Invocation:**

```bash
curl -X POST https://[appwrite-host]/v1/functions/send-otp/executions \
  -H "X-Appwrite-Key: [API_KEY]" \
  -H "Content-Type: application/json" \
  -d '{
    "otpID": "otp_123",
    "email": "[email protected]"
  }'

</details>



Also applies to: 140-157, 160-175

</blockquote></details>

</blockquote></details>

<details>
<summary>📜 Review details</summary>

**Configuration used**: defaults

**Review profile**: CHILL

**Plan**: Pro

<details>
<summary>📥 Commits</summary>

Reviewing files that changed from the base of the PR and between 795f29b30d5dfb304bd530753acb645d397e113e and a5e08f674c005f8d4d25bd8669b82ed798e53a11.

</details>

<details>
<summary>📒 Files selected for processing (1)</summary>

* `README.md`

</details>

<details>
<summary>🔇 Additional comments (1)</summary><blockquote>

<details>
<summary>README.md (1)</summary><blockquote>

`24-211`: **Well-structured documentation that meets all PR objectives.**

The Functions section has been effectively reorganized with standardized fields (Trigger, Description, Input, Output, Implementation) for each of the 10 backend functions. The clear categorization of trigger types (HTTP, Webhook, Cron, Appwrite Event) and consistent sections make it easy for contributors to understand how to invoke and extend each function. The Discussion Is-Time Checker is appropriately annotated as unimplemented, meeting the stated goal of documenting functions that lack implementation.

</blockquote></details>

</blockquote></details>

</details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->