Conversation
…correct Quick Start commands Agent-Logs-Url: https://github.com/dfeen87/HLV-RAPS/sessions/e29aafbb-fba9-411a-b53b-7b49b7632a5c Co-authored-by: dfeen87 <158860247+dfeen87@users.noreply.github.com>
Copilot created this pull request from a session on behalf of
dfeen87
April 5, 2026 15:20
View session
There was a problem hiding this comment.
Pull request overview
Documentation-only hardening pass to correct stale version references, fix a broken doc reference, and update Quick Start commands so they match the actual build targets and REST API endpoints.
Changes:
- Correct version strings across docs/metadata (v2.3 → v3.2, and CITATION year 2025 → 2026).
- Fix a broken telemetry dashboard doc reference in the telemetry storage contract.
- Update README Quick Start: clarify RTOS demo build expectations, correct REST API demo build/run steps, and fix the curl endpoint to
/health.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| README.md | Fixes Quick Start commands and endpoint to reflect actual API demo build/run + /health. |
| docs/TELEMETRY_DASHBOARD.md | Updates telemetry/dashboard doc to v3.2/v3.2.0 and adjusts future-version note. |
| docs/sil_hil.md | Wraps SIL/HIL diagram in a code fence and corrects alignment/labels. |
| docs/contracts/TELEMETRY_STORAGE_CONTRACT.md | Updates contract’s referenced RAPS version and fixes the telemetry dashboard file reference. |
| docs/architecture.md | Adds missing top-level title and completes the “types” sentence with the correct path. |
| CITATION.cff | Updates citation year to 2026 for consistency with repository licensing. |
| CHANGELOG.md | Corrects the VERSION file value shown under the [3.2.0] release entry. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Documentation polish pass correcting factual errors introduced or left unresolved after the first hardening round. No source code changes.
Version consistency
CHANGELOG.md: VERSION file value listed as(2.4.0)inside the[3.2.0]release entry →(3.2.0)CITATION.cff:year: 2025→year: 2026(matchesCopyright (c) 2026in LICENSE)docs/TELEMETRY_DASHBOARD.md: three stalev2.3/v2.3.0references →v3.2/v3.2.0docs/contracts/TELEMETRY_STORAGE_CONTRACT.md:(RAPS v2.3.0)in contract version line →(RAPS v3.2.0)Broken file reference
TELEMETRY_STORAGE_CONTRACT.mdreferenceddocs/telemetry_dashboard_v2.3.md(does not exist) →docs/TELEMETRY_DASHBOARD.mdIncorrect Quick Start commands
README.mdQuick Start impliedhlv_rtos_demoandrest_api_demoare produced by the SIL CMake build — they are not../build/hlv_rtos_demosnippet with prose clarifying it is a platform-specific reference example with no standalone CMake targetcmake -S examples/api_client -B build/api_demo && cmake --build build/api_demo && ./build/api_demo/rest_api_demo)/api/statusendpoint does not exist →/healthFormatting & completeness
docs/architecture.md: missing# System Architecturetitle; dangling final sentence"All timing and common scalar types are centralized in:"completed with the actual pathsrc/common/types.hppdocs/sil_hil.md: ASCII architecture diagram was unformatted raw text; wrapped in a code fence and fixed misaligned(SIL)/(HIL)labels