Skip to content

Align README and QUICKSTART docs with current repo, paths, and health-check endpoint#26

Merged
dfeen87 merged 1 commit into
mainfrom
copilot/fix-readme-and-quickstart-inconsistencies
Apr 16, 2026
Merged

Align README and QUICKSTART docs with current repo, paths, and health-check endpoint#26
dfeen87 merged 1 commit into
mainfrom
copilot/fix-readme-and-quickstart-inconsistencies

Conversation

Copilot AI commented Apr 16, 2026

Copy link
Copy Markdown
Contributor

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

    • Replaced pip install -r server/requirements.txt with pip install -r requirements.txt.
    • Standardized health-check documentation to /ping (including Render health check reference and endpoint table).
  • QUICKSTART consistency updates

    • Updated all repository clone URLs to:
      • https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
    • Updated path references to use:
      • ios/
      • android/
    • Removed all mentions of CONTRIBUTING.md.
# Before
pip install -r server/requirements.txt
healthCheckPath: /api/status
git clone https://github.com/dfeen87/respirosync.git
cd examples/ios
File → Open → Select respirosync/examples/android

# After
pip install -r requirements.txt
healthCheckPath: /ping
git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
cd ios/
File → Open → Select android/

…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>
@dfeen87
dfeen87 marked this pull request as ready for review April 16, 2026 13:23
Copilot AI review requested due to automatic review settings April 16, 2026 13:23
@dfeen87
dfeen87 merged commit cec74a6 into main Apr 16, 2026
4 checks passed
@dfeen87
dfeen87 deleted the copilot/fix-readme-and-quickstart-inconsistencies branch April 16, 2026 13:23

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.txt and document Render’s healthCheckPath as /ping.
  • Update QUICKSTART clone URL and app path references to ios/ and android/.
  • 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.

Comment thread README.md
|----------|-------------|
| `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) |

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Suggested change
| `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 |

Copilot uses AI. Check for mistakes.
Comment thread docs/QUICKSTART.md
Comment on lines +27 to 29
bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
cd respirosync

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/QUICKSTART.md
Comment on lines +32 to 34
bash cd ios/
open RespiroSyncDemo.xcodeproj

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.
Comment thread docs/QUICKSTART.md
Comment on lines 45 to 48
Open in Android Studio:

File → Open → Select respirosync/examples/android
File → Open → Select android/

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
Comment thread docs/QUICKSTART.md
Comment on lines +42 to 44
bash git clone https://github.com/dfeen87/Smartphone-Based-Chest-Monitoring
cd respirosync

Copilot AI Apr 16, 2026

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants