feat: add documentation for polls feature including API endpoints

[lairsinc]

Summary by CodeRabbit

• Documentation
  • Added a comprehensive guide for the Polls feature.
  • Includes an overview, how to create polls (with titles, options, and expiration), and the voting flow.
  • Provides clear examples for listing, creating, retrieving, updating, and deleting polls.
  • Highlights expected errors and rate-limiting behavior to help with reliable integration.

[coderabbitai]

Walkthrough

Adds a new documentation page describing the Polls feature, its REST endpoints, request/response patterns, example usage for creating polls and voting, and references to error handling and rate limiting.

Changes

Cohort / File(s)	Summary
Docs: Polls feature docs/polls.md	New document detailing Polls endpoints (GET/POST/PUT/DELETE /polls, GET /polls/:id, POST /polls/:id/vote), payloads (title, options, expiresAt), usage examples, and links to error handling and rate limiting.

Sequence Diagram(s)

sequenceDiagram
    autonumber
    participant U as User Client
    participant API as API Server
    participant S as Polls Service
    participant DB as Database

    rect rgba(230,245,255,0.6)
    note over U,API: Create Poll
    U->>API: POST /polls {title, options, expiresAt}
    API->>S: Validate & create poll
    S->>DB: INSERT poll, options
    DB-->>S: OK with pollId
    S-->>API: 201 Created {poll}
    API-->>U: 201 {poll}
    end

    rect rgba(240,255,230,0.6)
    note over U,API: Vote
    U->>API: POST /polls/:id/vote {optionId}
    API->>S: Record vote
    S->>DB: UPDATE vote counts
    DB-->>S: OK
    S-->>API: 200 {poll with tallies}
    API-->>U: 200 {updated poll}
    end

    rect rgba(255,245,230,0.6)
    note over U,API: Retrieve / Manage
    U->>API: GET /polls, GET /polls/:id
    API->>S: Fetch data
    S->>DB: SELECT polls
    DB-->>S: Results
    S-->>API: 200 {poll(s)}
    API-->>U: 200 {poll(s)}
    U->>API: PUT/DELETE /polls/:id
    API->>S: Update/Delete request
    S->>DB: UPDATE/DELETE
    DB-->>S: OK
    S-->>API: 200/204
    API-->>U: 200/204
    end

Loading

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Poem

I thump my paws, a vote to cast,
New polls arise, results amassed.
With options crisp and deadlines clear,
I nibble data without fear.
Hop, submit—tallies grow—
Carrots counted, onward go! 🥕📊

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 accurately and concisely describes the main purpose of the pull request by indicating that documentation for the polls feature and its API endpoints has been added, directly reflecting the changes in docs/polls.md.
Docstring Coverage	✅ Passed	No functions found in the changes. Docstring coverage check skipped.

✨ Finishing touches

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch docs/polls

---

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 651c224 and f9ee0ca.

📒 Files selected for processing (1)

• docs/polls.md (1 hunks)