Restore README badges and existing guidance - #108
Merged
Merged
Conversation
There was a problem hiding this comment.
Copilot review overview
🟡 Changes recommended
README guidance contains unresolved correctness and completeness issues.
Review effort: Lite
Findings: 4
Open (4)
What changed in this PR
Restores README badges, product guidance, section structure, and a v0.7.0 receipt example.
Changes:
- Restored six badges and documentation sections.
- Added generated receipt and artifact links.
- Updated commands, paths, delivery, and record guidance.
| File | Summary |
|---|---|
README.md |
Restored documentation and updated v0.7.0 workflow examples; documentation corrections remain needed. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| receipt. To preview destinations before sending, run `rio plan`. To use both destinations, put both | ||
| target entries under `delivery.targets`; plain `rio` sends each selected artifact to every eligible target. | ||
|
|
||
| Each invocation writes its receipt under `target/rio/runs/<run-id>/record.json` and prints its path. |
| printf 'Inspect the input and results in: %s\n' "$demo_dir" | ||
| ``` | ||
|
|
||
| The `index.json` in the printed run directory shows the version change (excerpt): |
Comment on lines
+421
to
+423
| For the quick-start sample's custom output location, use | ||
| `rio deliver --manifest "$demo_dir/rio.yaml" --index "$demo_dir/out/runs/RUN_ID/index.json"`, | ||
| replacing `RUN_ID` with the run printed by normalization. |
| ``` | ||
|
|
||
| Partial delivery preserves accepted, rejected, unknown and unattempted outcomes. A lost response is not a rejection. Rio does not automatically retry to obtain a receipt. Committed local checkpoints and journals support [offline crash recovery](docs/output.md#interruption-and-recovery), including when public-receipt publication fails after a request. | ||
| You get `app.cdx.json`, `index.json` and `record.json` in the printed run directory. Explicit artifact paths are relative to `rio.yaml`, and |
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.
Restore the README content and all six badges removed by #107, preserving the previous section order and product guidance. Show an actual JSON receipt excerpt as a feature example, linked to the complete generated file.
Update only the restored commands, output paths and retired record-format descriptions needed to keep that guidance correct for v0.7.0. No implementation or release changes.
Verified the badges and section order against the prior README, the JSON excerpt against the generated receipt, local links/anchors, and the quick start with the released v0.7.0 binary.
Follow-up to #106.