docs: change GET to POST for sign-in endpoint

[claudioavgo]

Summary by CodeRabbit

• Documentation
  • Updated authentication best practices example to use POST method for sign-in requests instead of GET, reflecting proper REST semantics for credential submission.

[coderabbitai]

Walkthrough

Documentation update corrects an authentication endpoint example, changing the HTTP method for the /sign-in route from GET to POST to align with standard request semantics for credential submission.

Changes

Cohort / File(s)	Change Summary
Documentation — Authentication Best Practices docs/essential/best-practice.md	Updated auth/index.ts code example: HTTP method for /sign-in route changed from GET to POST to reflect proper semantics for credential submission

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

• Single documentation file with a straightforward HTTP method correction in a code snippet
• No logic changes or functional impact—purely a documentation accuracy fix

Poem

🐰 From GET to POST, the sign-in does leap,
No more retrieving what should run deep,
Credentials submitted, not merely viewed,
REST semantics improved and renewed! ✨

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.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Title check	✅ Passed	The PR title accurately summarizes the main change: updating the /sign-in endpoint HTTP method from GET to POST in the documentation example.

✨ Finishing touches

• 📝 Generate docstrings

🧪 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)

docs/essential/best-practice.md (1)

63-63: Use spaces instead of hard tabs to comply with Markdown linting standards.

The static analysis tool flagged hard tabs on line 63. Replace the leading whitespace with spaces to comply with the MD010 rule.

📜 Review details

Configuration used: CodeRabbit UI

Review profile: CHILL

Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between a7ab7d3 and c2bfc47.

📒 Files selected for processing (1)

• docs/essential/best-practice.md (1 hunks)

🧰 Additional context used

🪛 markdownlint-cli2 (0.18.1)

docs/essential/best-practice.md

63-63: Hard tabs
Column: 1

(MD010, no-hard-tabs)

🔇 Additional comments (1)

docs/essential/best-practice.md (1)

55-80: Excellent: GET → POST aligns handler with HTTP semantics and security best practices.

The change from GET to POST for the /sign-in endpoint is semantically correct. The handler destructures credentials from the request body, which is an anti-pattern with GET (where params belong in query strings) but appropriate for POST. This also keeps sensitive credentials out of URLs and browser history.