docs: align local API port examples with current dev flow#250
docs: align local API port examples with current dev flow#250pandego wants to merge 2 commits intojamiepine:mainfrom
Conversation
📝 WalkthroughWalkthroughThe pull request updates local backend port references from 8000 to 17493 across documentation and a generation script, and adds a changelog entry documenting the generator script note. Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
📝 Coding Plan
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. Comment Tip You can customize the high-level summary generated by CodeRabbit.Configure the |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
🧹 Nitpick comments (2)
scripts/generate-api.sh (2)
34-34: Static analysis: Unused loop variablei.The loop variable
iis 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 17493argument, whilebackend/server.pydefaults 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--portargument. 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
📒 Files selected for processing (5)
CONTRIBUTING.mdREADME.mdbackend/README.mddocs/TROUBLESHOOTING.mdscripts/generate-api.sh
|
Addressed the two CodeRabbit nits in the latest push. What changed:
No behavior change expected - this is just a small cleanup pass on top of the docs port alignment update. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (2)
CHANGELOG.md (2)
58-58: Clarify "documents the local backend port" wording.The phrase "documents the local backend port" is somewhat vague. Consider more precise wording like "updated to use port 17493" or "aligned with port 17493" to make the change clearer to readers.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CHANGELOG.md` at line 58, Update the vague phrase "documents the local backend port" in the CHANGELOG entry to a precise description; replace it with something like "updated to use port 17493" or "aligned with port 17493" so readers know the exact port change, ensuring the sentence still reads naturally with the existing fragment "OpenAPI client generator script now ..." and keep the rest of the line unchanged.
58-58: Consider moving this entry to the "Changed" section.Since the primary change is aligning documentation with the current workflow (port 17493) rather than fixing broken functionality, this entry might fit better in a "Changed" section. The Keep a Changelog format typically reserves "Fixed" for bug fixes.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CHANGELOG.md` at line 58, Move the changelog entry "- OpenAPI client generator script now documents the local backend port and avoids an unused loop variable warning" out of the "Fixed" section and place it under the "Changed" section in CHANGELOG.md; locate the current "Fixed" and "Changed" headings and relocate that exact bullet so the entry reflects a documentation/workflow change rather than a bug fix.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CHANGELOG.md`:
- Line 58: Update the CHANGELOG entry to list all documentation files updated in
this PR and the specific port change: amend the line about the OpenAPI client
generator to also mention that README.md, backend/README.md, CONTRIBUTING.md,
and TROUBLESHOOTING.md were updated to change the local backend port reference
from 8000 to 17493 and note the removal of an unused loop variable warning in
the generator script; keep the wording concise and consistent with existing
changelog style.
---
Nitpick comments:
In `@CHANGELOG.md`:
- Line 58: Update the vague phrase "documents the local backend port" in the
CHANGELOG entry to a precise description; replace it with something like
"updated to use port 17493" or "aligned with port 17493" so readers know the
exact port change, ensuring the sentence still reads naturally with the existing
fragment "OpenAPI client generator script now ..." and keep the rest of the line
unchanged.
- Line 58: Move the changelog entry "- OpenAPI client generator script now
documents the local backend port and avoids an unused loop variable warning" out
of the "Fixed" section and place it under the "Changed" section in CHANGELOG.md;
locate the current "Fixed" and "Changed" headings and relocate that exact bullet
so the entry reflects a documentation/workflow change rather than a bug fix.
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: b95985c7-e14d-436f-9fce-dddbf5bbe8a5
📒 Files selected for processing (2)
CHANGELOG.mdscripts/generate-api.sh
🚧 Files skipped from review as they are similar to previous changes (1)
- scripts/generate-api.sh
|
|
||
| ### Fixed | ||
| - Audio export failing when Tauri save dialog returns object instead of string path | ||
| - OpenAPI client generator script now documents the local backend port and avoids an unused loop variable warning |
There was a problem hiding this comment.
Expand the changelog entry to include all documentation updates.
The current entry only mentions the generator script, but the PR updates multiple documentation files (README.md, backend/README.md, CONTRIBUTING.md, TROUBLESHOOTING.md) to align port references from 8000 to 17493. Users reading the changelog won't be aware of these important documentation updates.
📝 Suggested expanded entry
-- OpenAPI client generator script now documents the local backend port and avoids an unused loop variable warning
+- Updated local API port references from 8000 to 17493 across documentation (README.md, backend/README.md, CONTRIBUTING.md, TROUBLESHOOTING.md) and OpenAPI client generator script to align with current development workflow📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - OpenAPI client generator script now documents the local backend port and avoids an unused loop variable warning | |
| - Updated local API port references from 8000 to 17493 across documentation (README.md, backend/README.md, CONTRIBUTING.md, TROUBLESHOOTING.md) and OpenAPI client generator script to align with current development workflow |
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CHANGELOG.md` at line 58, Update the CHANGELOG entry to list all
documentation files updated in this PR and the specific port change: amend the
line about the OpenAPI client generator to also mention that README.md,
backend/README.md, CONTRIBUTING.md, and TROUBLESHOOTING.md were updated to
change the local backend port reference from 8000 to 17493 and note the removal
of an unused loop variable warning in the generator script; keep the wording
concise and consistent with existing changelog style.
1 participant
Summary
What changed
README.mdAPI examples to usehttp://localhost:17493backend/README.mdusage examples and note that manual launches can use a different host or portdocs/TROUBLESHOOTING.mdhealth and OpenAPI checks to use17493CONTRIBUTING.mdtroubleshooting guidance for OpenAPI client generationscripts/generate-api.shto matchbun run dev:serverWhy
The repo currently has mixed references to
8000and17493. The current local app, web client, and development workflow use17493, while some older docs and helper tooling still point at8000. This patch aligns the user-facing docs and the OpenAPI generation helper with the modern local/dev flow without changing backend runtime defaults.Validation
17493scripts/generate-api.shpreviously disagreed withbun run dev:serverSummary by CodeRabbit
Documentation
Chores
Changelog