docs: align local API port examples with current dev flow

[pandego]

Summary

• align local API examples with the current app and development workflow port
• update troubleshooting and OpenAPI generation guidance to use the same local default
• keep manual custom host/port usage documented without changing backend CLI defaults

What changed

• update README.md API examples to use http://localhost:17493
• update backend/README.md usage examples and note that manual launches can use a different host or port
• update docs/TROUBLESHOOTING.md health and OpenAPI checks to use 17493
• update CONTRIBUTING.md troubleshooting guidance for OpenAPI client generation
• update scripts/generate-api.sh to match bun run dev:server

Why

The repo currently has mixed references to 8000 and 17493. The current local app, web client, and development workflow use 17493, while some older docs and helper tooling still point at 8000. This patch aligns the user-facing docs and the OpenAPI generation helper with the modern local/dev flow without changing backend runtime defaults.

Validation

• reviewed the current app/web/Tauri/dev flow and confirmed they use 17493
• confirmed scripts/generate-api.sh previously disagreed with bun run dev:server
• avoided changing backend default port behavior in code

Summary by CodeRabbit

Release Notes

• Documentation

  • Updated API endpoint examples, configuration instructions, and troubleshooting guides to reflect the new default backend port (17493 instead of 8000) across all documentation files.

• Chores

  • Updated API generation script to use the new backend port configuration.

[coderabbitai]

📝 Walkthrough

Walkthrough

The pull request updates API endpoint references from port 8000 to port 17493 across documentation files and a shell script, reflecting the new default backend port for local development workflows.

Changes

Cohort / File(s)	Summary
Documentation Updates CONTRIBUTING.md, README.md, backend/README.md, docs/TROUBLESHOOTING.md	Updated API endpoint URLs and examples from localhost:8000 to localhost:17493. Added clarification notes about port variability and default configuration.
Build Script Updates scripts/generate-api.sh	Updated backend startup port, readiness checks, and OpenAPI schema retrieval from port 8000 to 17493. Control flow unchanged.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Poem

🐰 Hop hop, the port takes flight,
From eight-oh-oh to seventeen's light,
Docs and scripts now align with glee,
A unified home for the backend spree! 🚀

🚥 Pre-merge checks | ✅ 3

✅ 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 concisely summarizes the main objective: aligning documentation and API port examples to match the current development workflow's port (17493 instead of 8000).
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ 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]

🧹 Nitpick comments (2)

scripts/generate-api.sh (2)

34-34: Static analysis: Unused loop variable i.

The loop variable i is unused (SC2034). This is a pre-existing issue unrelated to this PR's changes, but you could suppress the warning or use _ as the variable name.

♻️ Optional fix to suppress warning

-    for i in {1..30}; do
+    for _ in {1..30}; do

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@scripts/generate-api.sh` at line 34, The for-loop in generate-api.sh uses an
unused loop variable `i` ("for i in {1..30}; do"), triggering SC2034; either
replace `i` with `_` (e.g., "for _ in {1..30}; do") to indicate intentional
unused variable or add a ShellCheck suppression comment above the loop (e.g., "#
shellcheck disable=SC2034") to silence the warning; update the loop header
surrounding "for i in {1..30}; do" accordingly.

---

29-29: Port configurations serve different contexts and are intentional.

The script uses port 17493 via explicit --port 17493 argument, while backend/server.py defaults to port 8000 when no port is specified. This design is reasonable: the script specifies its automation-specific port, while the backend remains flexible via the --port argument. Developers running the backend directly (python -m backend.main) will naturally use the default 8000, which is appropriate for local development.

If clarity is desired, consider adding an inline comment in the script noting why 17493 is used.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@scripts/generate-api.sh` at line 29, Add an inline comment next to the
uvicorn invocation in generate-api.sh explaining why the specific port 17493 is
used (automation/CI-specific port) to avoid confusion with backend/server.py's
default 8000; update the line containing the uvicorn command (uvicorn main:app
--port 17493 &) to include that brief explanatory comment.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@scripts/generate-api.sh`:
- Line 34: The for-loop in generate-api.sh uses an unused loop variable `i`
("for i in {1..30}; do"), triggering SC2034; either replace `i` with `_` (e.g.,
"for _ in {1..30}; do") to indicate intentional unused variable or add a
ShellCheck suppression comment above the loop (e.g., "# shellcheck
disable=SC2034") to silence the warning; update the loop header surrounding "for
i in {1..30}; do" accordingly.
- Line 29: Add an inline comment next to the uvicorn invocation in
generate-api.sh explaining why the specific port 17493 is used
(automation/CI-specific port) to avoid confusion with backend/server.py's
default 8000; update the line containing the uvicorn command (uvicorn main:app
--port 17493 &) to include that brief explanatory comment.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f63f0c53-c438-4d98-801c-3b72f4f23aa9

📥 Commits

Reviewing files that changed from the base of the PR and between 38bf96f and cdef216.

📒 Files selected for processing (5)

• CONTRIBUTING.md
• README.md
• backend/README.md
• docs/TROUBLESHOOTING.md
• scripts/generate-api.sh