docs: use Arkade terminology, remove stray "Ark" protocol references#36
Conversation
Replace standalone "Ark" with "Arkade" in comments, docs, and example contract source where it referred to Arkade's own server/node/runtime/ operator. Keeps the established `VTXO` output-format token and the real `github.com/arkade-os/contract-sdk-go/ark` Go package import untouched. https://claude.ai/code/session_01Qh7PueuU2EciLbgmHzHvBx
|
Caution Review failedThe pull request is closed. ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (14)
WalkthroughThis PR systematically updates terminology across the codebase from "Ark" to "Arkade." Changes span user documentation (README, specification, examples), library comments (IR, code generation targets, validator), and generated code templates with corresponding test assertion updates. ChangesArk to Arkade terminology update
🎯 1 (Trivial) | ⏱️ ~3 minutes ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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. Comment |
Playground PreviewA live preview of this PR's playground is available at:
|
There was a problem hiding this comment.
Review: docs terminology rename (Ark → Arkade)
Verdict: APPROVE ✅
Reviewed the full diff across all 14 files and cross-checked remaining ark/Ark references in the codebase.
What this PR does
Pure docs/comments rename: standalone "Ark" → "Arkade" in comments, docstrings, example contract comments, and markdown docs. No logic, no API, no codegen output changes.
Verified correct
- Go package paths preserved:
github.com/arkade-os/contract-sdk-go/ark,ark.Contract,ark.WitnessStack,ark.Raw, etc. are all real Go identifiers — correctly left untouched. .arkfile extension preserved: The language extension is.ark, not.arkade— correctly untouched.VTXOtoken preserved: As stated in the PR description.- No remaining stray
\bArk\b: Grepped the full tree on the PR branch — zero hits for standalone capitalized "Ark" outside of Go package identifiers. go.rs:141-144reformatting: Theformat!macro was split across lines (rustfmt style). Output is identical — verified by reading the full function.- Test assertions updated in lockstep:
go_test.rs:43andtypescript_test.rs:45both updated to assert the new "Arkade server" string. Tests will catch any drift. playground/codegen.jsupdated in all three places: Lines 166, 258, 267 — consistent with the Rust codegen targets.
Cross-repo impact
None. This PR changes only comments, docstrings, and documentation. No public API, type, proto, or generated output is modified. Downstream SDKs and consumers are unaffected.
Protocol-critical
Not applicable — no protocol logic touched.
Clean PR. Ship it.
Replace standalone "Ark" with "Arkade" in comments, docs, and example
contract source where it referred to Arkade's own server/node/runtime/
operator. Keeps the established
VTXOoutput-format token and the realgithub.com/arkade-os/contract-sdk-go/arkGo package import untouched.https://claude.ai/code/session_01Qh7PueuU2EciLbgmHzHvBx
Summary by CodeRabbit
Documentation
Tests