Skip to content

docs: README accuracy sweep (schema field names, keystore path, versioning)#35

Merged
proofmancer merged 1 commit into
mainfrom
docs/audit-fixes-2026-05-17
May 17, 2026
Merged

docs: README accuracy sweep (schema field names, keystore path, versioning)#35
proofmancer merged 1 commit into
mainfrom
docs/audit-fixes-2026-05-17

Conversation

@proofmancer
Copy link
Copy Markdown
Member

Launch-eve docs-vs-code accuracy sweep. Sibling PRs land at the same time on ligate-chain, ligate-js, ligate-api, ligate-explorer, ligate-marketing.

What changed

  • register-schema JSON example field names corrected against src/register_schema.rs:73-82: fee_routing_addressfee_routing_addr, payload_spec_hashpayload_shape_hash. Partners copy-pasting the README example were getting serde errors on unknown fields.
  • Linux keystore path corrected: ProjectDirs::from("io", "ligate", "cli") resolves to $XDG_DATA_HOME/cli/keys (the directories crate drops the org qualifier on Linux). README previously said $XDG_DATA_HOME/ligate/keys.
  • Added "Current release: v0.1.2-devnet" sibling line in Status section so future bumps don't go stale.
  • Tarball install example bumped from v0.1.0-devnet to v0.1.2-devnet.
  • Added publish = false note alongside the SDK-pin-blocked crates.io reason.
  • "Only ligate node start is still deferred" rephrased to "not in scope for v0".
  • New "Versioning" subsection citing ligate-chain#374 (the convention shift to plain semver; next CLI release drops -devnet).

Test plan

  • CI green (docs-only)

@proofmancer proofmancer merged commit 8635088 into main May 17, 2026
5 checks passed
@proofmancer proofmancer deleted the docs/audit-fixes-2026-05-17 branch May 17, 2026 13:15
@github-actions github-actions Bot locked and limited conversation to collaborators May 17, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant