Skip to content

docs: use Arkade terminology, remove stray "Ark" protocol references#36

Merged
tiero merged 1 commit into
masterfrom
claude/arkade-codebase-review-tvZig
May 28, 2026
Merged

docs: use Arkade terminology, remove stray "Ark" protocol references#36
tiero merged 1 commit into
masterfrom
claude/arkade-codebase-review-tvZig

Conversation

@tiero

@tiero tiero commented May 28, 2026

Copy link
Copy Markdown
Member

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

Summary by CodeRabbit

Documentation

  • Updated product terminology references throughout README, API specifications, example contracts, developer guides, and auto-generated documentation comments.
  • Ensured consistent naming conventions across user-facing documentation and technical specifications.

Tests

  • Updated test fixtures and assertions for code generation tests (Go and TypeScript backends) to align with terminology changes.

Review Change Stack

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
@coderabbitai

coderabbitai Bot commented May 28, 2026

Copy link
Copy Markdown

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: c2007fa1-a036-4684-aba4-83e6af7dfbbd

📥 Commits

Reviewing files that changed from the base of the PR and between 63dc58e and 7c72093.

📒 Files selected for processing (14)
  • README.md
  • arkade-bindgen/src/ir.rs
  • arkade-bindgen/src/targets/go.rs
  • arkade-bindgen/src/targets/typescript.rs
  • arkade-bindgen/tests/go_test.rs
  • arkade-bindgen/tests/typescript_test.rs
  • docs/ArkadeKitties.md
  • docs/arkade-primitives-spec.md
  • examples/htlc.ark
  • examples/single_sig.ark
  • examples/threshold_multisig_htlc.ark
  • playground/codegen.js
  • src/validator/mod.rs
  • tests/asm_structural_test.rs

Walkthrough

This 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.

Changes

Ark to Arkade terminology update

Layer / File(s) Summary
User-facing documentation
README.md, docs/ArkadeKitties.md, docs/arkade-primitives-spec.md
README VTXO placeholder resolution, ArkadeKitties system description, and primitives spec Phase 7 comment are updated to reference "Arkade" instead of "Ark".
Core library and example comments
arkade-bindgen/src/ir.rs, arkade-bindgen/src/targets/go.rs, arkade-bindgen/src/targets/typescript.rs, src/validator/mod.rs, examples/htlc.ark, examples/single_sig.ark, examples/threshold_multisig_htlc.ark
Field documentation, code generation comments, validator module docs, and example contract renewal comments are updated to reference "Arkade server" and "Arkade node" instead of "Ark".
Generated code and test assertions
playground/codegen.js, arkade-bindgen/tests/go_test.rs, arkade-bindgen/tests/typescript_test.rs, tests/asm_structural_test.rs
Code generation templates and test assertions updated to expect witness comments with "Arkade server" terminology; test comments reference "Arkade operator".

🎯 1 (Trivial) | ⏱️ ~3 minutes

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/arkade-codebase-review-tvZig

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.

@github-actions

Copy link
Copy Markdown
Contributor

Playground Preview

A live preview of this PR's playground is available at:
https://arkade-os.github.io/compiler/pr-previews/pr-36/

Built from commit ba70eaa1fc1edf7cb4c690950904b1906e217d2a · Workflow run

@tiero tiero merged commit 4dcfdc3 into master May 28, 2026
4 of 5 checks passed

@arkanaai arkanaai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.
  • .ark file extension preserved: The language extension is .ark, not .arkade — correctly untouched.
  • VTXO token 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-144 reformatting: The format! macro was split across lines (rustfmt style). Output is identical — verified by reading the full function.
  • Test assertions updated in lockstep: go_test.rs:43 and typescript_test.rs:45 both updated to assert the new "Arkade server" string. Tests will catch any drift.
  • playground/codegen.js updated 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.

github-actions Bot added a commit that referenced this pull request May 28, 2026
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