Align README and QUICKSTART docs with current repo, paths, and health-check endpoint#26
Conversation
…xample paths, CONTRIBUTING.md removal) Agent-Logs-Url: https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring/sessions/7f73fd0c-15e7-4774-89fd-0f8b1be3d6fe Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates setup/deployment documentation to match the current repository layout and the intended health-check endpoint used by Render.
Changes:
- Update README install instructions to use the root
requirements.txtand document Render’shealthCheckPathas/ping. - Update QUICKSTART clone URL and app path references to
ios/andandroid/. - Remove QUICKSTART references to
CONTRIBUTING.md.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| docs/QUICKSTART.md | Updates clone URL and path references for iOS/Android quickstart instructions |
| README.md | Updates dependency install path and normalizes documented health-check endpoint to /ping |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| |----------|-------------| | ||
| | `GET /` | Dashboard UI — status, metrics, configuration, live logs, validation | | ||
| | `GET /api/status` | System status (version, uptime, pipeline name) | | ||
| | `GET /ping` | System status (version, uptime, pipeline name) | |
There was a problem hiding this comment.
The endpoint table now says GET /ping returns “System status (version, uptime, pipeline name)”, but /ping in server/app.py only returns {"pong": true} and the status/version/uptime fields live under GET /api/status (JWT-protected). Update the table description to match /ping, and keep/restore a separate /api/status entry (noting auth) if you want to document system status.
| | `GET /ping` | System status (version, uptime, pipeline name) | | |
| | `GET /ping` | Lightweight health check (`{"pong": true}`) | | |
| | `GET /api/status` | System status (version, uptime, pipeline name) — JWT required | |
| bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring | ||
| cd respirosync | ||
|
|
There was a problem hiding this comment.
After git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring the default checkout directory will be Smartphone-Based-Chest-Monitoring/, not respirosync/. Either change the next line to cd Smartphone-Based-Chest-Monitoring or use git clone … respirosync if you want to keep cd respirosync.
| bash cd ios/ | ||
| open RespiroSyncDemo.xcodeproj | ||
|
|
There was a problem hiding this comment.
The iOS instructions still reference open RespiroSyncDemo.xcodeproj, but there are no .xcodeproj/.xcworkspace files in the repository under ios/ (only ios/RespiroSyncDemo/ContentView.swift…). Update this step to point to the actual Xcode project/workspace (or update the repo to include it if it’s expected to exist).
| Open in Android Studio: | ||
|
|
||
| File → Open → Select respirosync/examples/android | ||
| File → Open → Select android/ | ||
|
|
There was a problem hiding this comment.
The Android step says to open android/ in Android Studio, but the android/ subtree in this repo doesn’t contain the usual project files (settings.gradle, build.gradle, AndroidManifest.xml, etc.), so Android Studio won’t be able to import/build from these instructions as written. Either point to the correct Android Studio project directory (if different) or clarify that this repo contains only the Android integration sources, not a buildable demo app.
| bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring | ||
| cd respirosync | ||
|
|
There was a problem hiding this comment.
Same issue as above: cloning https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring won’t create a respirosync/ directory unless you specify it as the target dir. Update cd respirosync accordingly (or change the clone command to include a destination folder name).
This PR resolves documentation drift across setup/deployment docs by correcting install path references, normalizing the documented health-check endpoint to
/ping, and updating QUICKSTART repo/path references to match the current repository layout.README corrections
pip install -r server/requirements.txtwithpip install -r requirements.txt./ping(including Render health check reference and endpoint table).QUICKSTART consistency updates
https://github.com/dfeen87/Smartphone-Based-Chest-Monitoringios/android/CONTRIBUTING.md.