Skip to content

docs: remove OA v3 references and add CLI comparison guide#13

Merged
rongquan1 merged 4 commits into
mainfrom
develop
May 28, 2026
Merged

docs: remove OA v3 references and add CLI comparison guide#13
rongquan1 merged 4 commits into
mainfrom
develop

Conversation

@RishabhS7
Copy link
Copy Markdown
Contributor

@RishabhS7 RishabhS7 commented May 28, 2026

Summary

  • Removed all OpenAttestation v3 references from documentation — TrustVC only supports OA v2, and several pages incorrectly implied v3 was a supported format
  • Added a new CLI Comparison guide under Migration / Upgrading that explains why users should move from the deprecated @tradetrust-tt/tradetrust-cli and @trustvc/w3c-cli to @trustvc/trustvc-cli

Changes

fix: remove OA v3 references from documentation

  • docs/getting-started.md — Updated intro and verifyDocument API table to specify "OA v2" instead of generic "OpenAttestation"
  • docs/how-tos/verifydocument.md — Updated overview, DOCUMENT_INTEGRITY, DOCUMENT_STATUS, ISSUER_IDENTITY, and rpcProviderUrl sections to say "OpenAttestation v2" throughout
  • docs/how-tos/attachments.md — Removed isV3Document(document) branch from the attachment extraction example
  • docs/tutorial/decentralized-renderer.md — Cleaned up two comments referencing OA v3

docs: add CLI Comparison guide

  • docs/migration-guide/cli-comparison.md — New page with a full 18-capability feature matrix across all three CLIs, per-CLI summaries with deprecation context, migration steps, and a dev/test-only disclaimer
  • sidebars.json — Wired the new page into the Migration / Upgrading section

Test plan

  • Verify docs build without errors
  • Confirm sidebar link to "Why Move to TrustVC CLI" resolves correctly
  • Spot-check that no remaining "OA v3" or "OpenCert" references appear in the updated pages
  • Confirm the CLI feature matrix renders correctly in the browser

Summary by CodeRabbit

  • Documentation
    • Clarified TrustVC support for OpenAttestation v2 Verifiable Documents across all relevant guides
    • Updated documentation for attachment handling, QR code resolution, and verification processes
    • Added migration guide to help users transition from legacy CLI tools to TrustVC CLI

Review Change Stack

RishabhS7 and others added 4 commits May 20, 2026 06:41
Adds a new migration page that compares @trustvc/trustvc-cli with the
deprecated @tradetrust-tt/tradetrust-cli and @trustvc/w3c-cli, including
a feature matrix and a migration call-to-action. Wires the page into the
Migration / Upgrading section of the sidebar.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 28, 2026

Caution

Review failed

Pull request was closed or merged during review

📝 Walkthrough

Walkthrough

Documentation refactored to clarify TrustVC's support for OpenAttestation v2 and W3C Verifiable Credentials, removing OA v3 references from feature guides. A new CLI migration guide directs users from deprecated TradeTrust and w3c-cli tools to the actively maintained TrustVC CLI, with sidebar wiring added.

Changes

OpenAttestation v2 Focus and CLI Migration

Layer / File(s) Summary
Getting Started API Scope Clarification
docs/getting-started.md
Introduction and Core Functions Reference table updated to specify OpenAttestation v2 support (narrowed from v2/v3), restricting signOA to v2-only and verifyDocument to W3C VC or OA v2 VD, removing OpenCert mentions.
verifyDocument Function Documentation
docs/how-tos/verifydocument.md
Function description now explicitly targets OpenAttestation v2 alongside W3C VC. Verification fragment sections (DOCUMENT_INTEGRITY, DOCUMENT_STATUS, ISSUER_IDENTITY) clarified with v2-specific behavior: Merkle root/hash integrity, on-chain store/token-registry revocation checks, and DNS-TXT/DNS-DID identity resolution. rpcProviderUrl documentation narrowed to on-chain verification requirement.
Feature How-To Guides (Attachments and QR Codes)
docs/how-tos/attachments.md, docs/how-tos/implementing-qr-codes.md
OpenAttestation v3 references removed throughout. Attachments guide deletes legacy v3 section and narrows to OA v2 field precedence (fileName, type fallbacks). QR-code guide specifies OA v2 link location as data.links.self.href, removing v3 credentialSubject.links.self.href references.
CLI Migration Guide and Sidebar Registration
docs/migration-guide/cli-comparison.md, sidebars.json
New migration guide explains transition from deprecated @tradetrust-tt/tradetrust-cli and @trustvc/w3c-cli to @trustvc/trustvc-cli, including feature comparison table, consolidated capabilities (W3C VC, OA v2/v3, token registry v4/v5), and installation/usage examples. Guide registered in sidebar under Migration/Upgrading section.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Possibly related PRs

Suggested reviewers

  • rongquan1

Poem

🐰 OpenAttestation v3, we bid farewell so neat,
V2 and W3C VC make the story complete.
Old CLIs fade to dust, TrustVC takes the stage,
Fresh migration guides illuminate the page.
Hopping toward clarity, one doc at a time! 🎉

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main changes: removing OA v3 references and adding a CLI comparison guide, matching the primary objectives.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch develop

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@rongquan1 rongquan1 merged commit 8f6f3f9 into main May 28, 2026
7 of 8 checks passed
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.

2 participants