docs: sync README, MCP docs and architecture with released v0.6.0 - #19
Merged
Conversation
![claude[bot]](https://avatars.githubusercontent.com/in/1236702?s=60&v=4){kind=small}
There was a problem hiding this comment.
An organization admin can view or raise the cap at claude.ai/admin-settings/claude-code. The cap resets at the start of the next billing period.
Once the cap resets or is raised, reopen this pull request to trigger a review.
There was a problem hiding this comment.
Pull request overview
Synchronizes release-facing documentation with v0.6.0, including GitHub Actions, MCP examples, architecture, and changelog content.
Changes:
- Pins Action examples to
v0.6.0. - Updates MCP version examples to
0.6.0. - Documents the dashboard module layout.
- Removes stale unreleased changelog text.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Summary |
|---|---|
| README.md | Updates Action guidance. Nit (4 votes): align action.yml metadata and failure guidance with the released gate. |
| docs/usage.md | Updates gate Action documentation. |
| docs/mcp.md | Updates MCP health version examples. |
| docs/mcp-smoke.md | Updates smoke-test versions. |
| docs/gate-playbook.md | Pins the CI Action to v0.6.0. |
| docs/architecture.md | Documents the dashboard module structure. Nit (3 votes): update the duplicate listing in docs/development.md. |
| CHANGELOG.md | Removes stale unreleased notes. |
Suppressed comments (3)
docs/architecture.md:437
- The new
fontsclaim is not reflected by the implementation:assets.rsembeds CSS/JavaScript, while the generated HTML explicitly documents a system-font stack with no external CDN and there are no embedded font assets. Please describe this as embedded CSS/JS (or mention the system font stack) instead.
rendering), `assets.rs` (embedded CSS/JS/fonts), and `tests.rs`/`trends_tests.rs`.
docs/gate-playbook.md:262
- This snippet now points at v0.6.0, but the action definition remains stale:
action.yml:11-15still uses0.5.0as its example and says to pin only onceprview gateis published, whileaction.yml:81still tells users to wait for 0.6.0. Updateaction.ymltoo so this release sync does not leave users with contradictory guidance.
- uses: vetcoders/prview-rs@v0.6.0 # pin to a released tag
docs/usage.md:140
- This snippet now points at v0.6.0, but the action definition remains stale:
action.yml:11-15still uses0.5.0as its example and says to pin only onceprview gateis published, whileaction.yml:81still tells users to wait for 0.6.0. Updateaction.ymltoo so this release sync does not leave users with contradictory guidance.
- uses: vetcoders/prview-rs@v0.6.0 # pin to a released tag
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6232c1bd0b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 7 out of 8 changed files in this pull request and generated no new comments.
Suppressed comments (2)
README.md:149
- The Action metadata is still out of sync with this update:
action.yml:11-14describes0.5.0as the example and says to pin the release only onceprview gateis published. That text is shown to Action users and contradicts the newv0.6.0guidance, so update the input description to the released state as well.
- uses: vetcoders/prview-rs@v0.6.0 # pin to a released tag
docs/architecture.md:50
- This refresh leaves another repository-layout document stale:
docs/development.md:100still listssrc/artifacts/dashboard.rs, but that file no longer exists and the module is nowsrc/artifacts/dashboard/. Please update that map too so readers do not follow a nonexistent path.
│ │ └── dashboard/ # HTML dashboard generation (mod.rs, sections.rs, assets.rs, tests)
…e map, 0.6.0 loctree notes) - action.yml: update version-input description and gate-missing guidance to reflect that `prview gate` shipped with the released v0.6.0, instead of describing it as not yet published. - docs/development.md: fix the code-structure tree entry for src/artifacts/dashboard.rs, which is now the dashboard/ module directory (mod.rs, sections.rs, assets.rs, tests), matching architecture.md. - CHANGELOG.md: restore the loctree 0.13 observable-behavior details (stale 0.8-era caches auto-rescanned via the schema gate; broadened LOCTREE totals for non-source files) under the 0.6.0 Changed section instead of dropping them when they were removed from Unreleased. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr
…e description Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 9 out of 10 changed files in this pull request and generated no new comments.
Suppressed comments (1)
CHANGELOG.md:37
- The PR description says historical changelog sections are untouched, but this line rewrites the existing 0.6.0 entry with new implementation details. Please revert this unrelated historical edit (or update the PR scope/description if it is intentional) so the change only removes the stale Unreleased prose and records the new security update.
- build(deps): bump loctree 0.8 → 0.13.0 — source-compatible; stale 0.8-era caches are rescanned automatically via the schema gate, and the wider file-type scan coverage broadens the `LOCTREE` heuristics totals (`total_files`, `total_loc`, `by_language`) for the same tree
m-szymanska
pushed a commit
that referenced
this pull request
Aug 22, 2026
…dup) Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr # Conflicts: # CHANGELOG.md
m-szymanska
pushed a commit
that referenced
this pull request
Aug 22, 2026
…trate) Merge, not rebase: the 44 resolved review threads on this PR are anchored to their commits. One conflict, CHANGELOG.md, and it was a both-added `[Unreleased]`: the two campaigns wrote the section independently from the same empty base. Resolved as a union, every bullet from both sides kept verbatim and re-sectioned as Added / Changed / Fixed / Security -- 3 Added (1 from the verdict line, 2 from substrate), 11 Changed, 37 Fixed (24 + 13), 1 Security. The ammonia entry is main's single canonical one, not a second copy. The loctree-bump bullet, inherited by both sides from the merge base, is deduplicated back to one. Main's copy also carried a committed conflict marker inside `[Unreleased]` -- a literal `||||||| 5177ace` line followed by a duplicate `### Changed` block. Resolving this file into a state that still contained a stray marker was not an option, so the marker and its duplicate block are gone. The released history below `[Unreleased]` is byte-identical to main, including #19's expanded 0.6.0 loctree entry. Everything else auto-merged. Cargo.lock and Cargo.toml come out byte-identical to main (ammonia 4.1.4): this branch changes no dependency. The shared code and docs carry both behaviours -- the substrate/provenance work and the verdict-vocabulary, needle-edge, declaration-cap and test-context work sit in different functions and different sections. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr
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.
Summary
Documentation still described the pre-0.6.0 world. This PR syncs the edges with the released state:
vetcoders/prview-rs@v0.6.0instead of@mainwith a "once one shipsprview gate" caveat (the gate shipped in v0.6.0). Removed the stale note claiming the gate is absent from the released crate.healthexample versions bumped0.3.1/0.5.0→0.6.0(runtime reportsCARGO_PKG_VERSION).src/artifacts/dashboard/module (mod.rs, sections.rs, assets.rs, tests) instead of the long-gone singledashboard.rs.Unreleasedprose section that described the loctree 0.8→0.13 bump as upcoming; it is already recorded under## [0.6.0]. Historical sections untouched.ammonia4.1.3 → 4.1.4 (RUSTSEC-2026-0213: XSS via SVGanimate/setattributes). Not docs: a real security cut, called out here so reviewers reading only the summary see it.Every change was verified against the live tree (
git tag,Cargo.toml,ls src/artifacts/dashboard/,loct find) — details in commit.Verification
cargo test --doc— ok (1 passed)grep -rn "0.3.1" docs/ README.md— no current-state hits remainPart of the 2026-08-22 "truth under the hood" campaign (bugslog family: PRV-DOCS-EDGE-DRIFT). Sibling PRs will cover substrate truth and verdict/signal truth.
🤖 Generated with Claude Code
https://claude.ai/code/session_01Nqgpf1YwXw2m3vqC8Ur8nr