Update README with missing function docs

[shivansh31414]

Summary

Updated README.md to include missing functions:

• send-story-notification
• start-friend-call
• sync-all-documents-with-meilisearch
• sync-stories-with-meilisearch
• sync-users-with-meilisearch
• upcomingRoom-Message-Notification

Related Issue

Fixes #122

Notes

• Added one-line descriptions for each function, matching existing format.

Summary by CodeRabbit

• Documentation
  • Added docs for new serverless functions: Story notifications, Friend call initiation, Upcoming room message notifications, and Meilisearch sync for documents, stories, and users.
  • Removed the prior database-cleaner entry and adjusted formatting in the Functions list.

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

[coderabbitai]

Walkthrough

README.md updated to remove the database-cleaner entry and add six function entries: send-story-notification, start-friend-call, sync-all-documents-with-meilisearch, sync-stories-with-meilisearch, sync-users-with-meilisearch, and upcomingRoom-Message-Notification; trailing "cleanup" token adjusted.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Removed database-cleaner entry; added six function entries: functions/send-story-notification, functions/start-friend-call, functions/sync-all-documents-with-meilisearch, functions/sync-stories-with-meilisearch, functions/sync-users-with-meilisearch, functions/upcomingRoom-Message-Notification; adjusted trailing formatting ("cleanup" token).

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Single Markdown file change; documentation-only update.
• No code, tests, or behavior changes; review focused on correctness and formatting.

Poem

🐰 I hopped through lines and found new things to chart,
Six little functions tucked into the heart.
Stories, calls, and searches spring,
A README refreshed — I dance and sing! 🥕✨

Pre-merge checks and finishing touches

✅ Passed checks (5 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title clearly describes the main change: updating the README with documentation for previously missing functions.
Linked Issues check	✅ Passed	The PR successfully addresses all requirements from issue #122 by adding documentation for all six missing functions to the README.
Out of Scope Changes check	✅ Passed	The PR only modifies README.md to document missing functions as specified in issue #122; no out-of-scope changes detected.
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

---

📜 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 8bc24d3 and cf32e8e.

📒 Files selected for processing (1)

• README.md (1 hunks)

🔇 Additional comments (1)

README.md (1)

42-52: Function list updated with all six missing functions and consistent formatting.

The new entries correctly add all six functions from issue #122, maintaining the existing documentation format with proper enumeration (j–o), linked function paths, and clear one-line descriptions. The descriptions are more detailed than some existing entries, which improves documentation quality.

However, please verify the following before merge:

1. Confirm "cleanup" token removal: A past review flagged a stray "cleanup" token at the end of the file. Please confirm this has been removed in the final version.

2. Verify function paths exist: Ensure all six linked paths exist in the /functions directory with exact casing, particularly upcomingRoom-Message-Notification which uses mixed camelCase and hyphens.

Run this script to verify:

#!/bin/bash
functions=(
  "send-story-notification"
  "start-friend-call"
  "sync-all-documents-with-meilisearch"
  "sync-stories-with-meilisearch"
  "sync-users-with-meilisearch"
  "upcomingRoom-Message-Notification"
)

for func in "${functions[@]}"; do
  if [ -d "functions/$func" ]; then
    echo "✓ functions/$func exists"
  else
    echo "✗ functions/$func NOT FOUND"
  fi
done

if tail -c 10 README.md | grep -q "cleanup"; then
  echo "⚠ WARNING: Stray 'cleanup' token found at EOF"
else
  echo "✓ No stray 'cleanup' token at EOF"
fi

---

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: 1

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 795f29b and 8bc24d3.

📒 Files selected for processing (1)

• README.md (2 hunks)

🔇 Additional comments (1)

README.md (1)

42-52: Well-structured function documentation additions.

The new function entries follow the established format and naming conventions. The Meilisearch sync functions are standard patterns for syncing documents from Appwrite database collections to Meilisearch indexes, and the descriptions clearly convey their purpose.

[M4dhav]

Hey @shivansh31414 , to work on an issue it is necessary to be assigned to the issue by requesting it first. As other contributors requested to be assigned first, I cannot accept this PR