Skip to content

Update Documention: README missing documentation for several functions #122

@mahatolalit

Description

@mahatolalit

While reviewing the README, I noticed it's out of sync with the actual codebase. The README currently lists 10 functions, but there are more in the /functions directory.

Missing functions:

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

Steps to Reproduce:

  1. Open README.md
  2. Compare the functions section with the contents of /functions
$ ls functions/
create-room  database-cleaner  delete-room  join-room  livekit-webhook  match-maker  send-otp  send-story-notification  start-friend-call  sync-all-documents-with-meilisearch  sync-stories-with-meilisearch  sync-users-with-meilisearch  upcomingRoom-Message-Notification  upcomingRoom-isTime-checker  verify-email  verify-otp

Suggestion:
Add a one-line description for each missing function, matching the existing format in the README.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationgood first issueGood for newcomers

Type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions