Update Readme: added the info for the functions not defined in the readme, Fixes #122

[ayush00git]

As per the requested missing fields in the Issue #122 I have added the definitions of the functions that were previously missing.

Summary by CodeRabbit

• Documentation
  • Updated README with seven new function references and descriptions for improved developer guidance.

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

[coderabbitai]

Walkthrough

Seven new function entries were added to the README file, documenting functions for story notifications, friend calls, and Meilisearch synchronization tasks. Each entry includes a function path label and descriptive purpose statement.

Changes

Cohort / File(s)	Summary
Documentation Updates README.md	Added seven new function entries: send-story-notification, start-friend-call, sync-all-documents-with-meilisearch, sync-stories-with-meilisearch, sync-users-with-meilisearch, upcomingRoom-isTime-checker, and upcomingRoom-Message-Notification, each with descriptive one-line summaries.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

• Review consists solely of documentation additions with no functional code changes
• Verify that function names are accurately spelled and correspond to actual implementations
• Confirm descriptions are clear and concise

Poem

🐰 Seven new functions now documented with pride,
In the README where descriptions reside,
Notifications and syncs, calls and timely checks—
Our functions are ready, no code is a wreck! 📚✨

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 clearly and specifically describes the main change: updating the README with function definitions that were previously missing, referencing the related issue.
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

---

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

🧹 Nitpick comments (1)

README.md (1)

44-56: Remove blank lines to maintain consistent formatting with existing entries.

The new function entries have blank lines interspersed between them, whereas the existing entries (a-j) are formatted without blank lines. This creates a visual inconsistency in the documentation.

Remove the blank lines on 45, 47, 49, 51, 53, and 55 to align with the existing formatting style.

 (k) [send-story-notification](functions/send-story-notification/) : Function to send notifications when stories are posted or updated (notifies followers or relevant users).
-
 (l) [start-friend-call](functions/start-friend-call/) : Function to initiate a direct friend-to-friend voice call, creating/joining LiveKit sessions and updating call records.
-
 (m) [sync-all-documents-with-meilisearch](functions/sync-all-documents-with-meilisearch/) : Function to synchronize all relevant database collections and documents with Meilisearch indices for global search availability.
-
 (n) [sync-stories-with-meilisearch](functions/sync-stories-with-meilisearch/) : Function to keep story documents in sync with the Meilisearch index so stories are searchable.
-
 (o) [sync-users-with-meilisearch](functions/sync-users-with-meilisearch/) : Function to index and synchronize user documents with Meilisearch for user search and discovery.
-
 (p) [upcomingRoom-isTime-checker](functions/upcomingRoom-isTime-checker/) : Cron function to check scheduled upcoming rooms and activate or mark them ready when their start time is near.
-
 (q) [upcomingRoom-Message-Notification](functions/upcomingRoom-Message-Notification/) : Function to send reminders/notifications to users about upcoming rooms (e.g., reminders before start time).

Please verify that the function paths (e.g., functions/send-story-notification/, functions/start-friend-call/) match the actual function directories in the repository.

📜 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 97bf651.

📒 Files selected for processing (1)

• README.md (1 hunks)

[ayush00git]

Hey @M4dhav please have a look at the PR and consider merging it if everything seems fine. If there are still any changes you like, please do guide me through them.