Skip to content

docs: align chains and validation mechanism with current codebase - #17

Merged
AndreaRaccagni merged 1 commit into
mainfrom
docs/align-with-codebase
May 25, 2026
Merged

docs: align chains and validation mechanism with current codebase#17
AndreaRaccagni merged 1 commit into
mainfrom
docs/align-with-codebase

Conversation

@AndreaRaccagni

Copy link
Copy Markdown
Collaborator

What

Updates docs (and the llms.txt description in astro.config.mjs) to match
what's actually in the go-vsc-node codebase. Eight files, all small
wording corrections.

Why

@LordButterfly flagged that current docs overstate ZK proofs and list
Solana as supported when it isn't yet. Verified against the codebase:

  • modules/oracle/chain/ contains bitcoin.go, ethereum.go, dash.go,
    litecoin.go — no solana.go
  • modules/common/system-config/system-config.go: only BTC and ETH
    have deployed mapping contracts on mainnet
  • modules/oracle/chain/chain_relay.go: validation mechanism is BLS-
    signed consensus over native node observation, not ZK proofs
  • ZK in code: cmd/zk-tx-signer (SP1-Helios prover sidecar for ETH)
    and modules/wasm/sdk/sp1_verifier.go (contract-level SDK helper)

Files changed

  • astro.config.mjs (llms.txt description)
  • src/content/docs/index.mdx (4 corrections)
  • src/content/docs/Technology/index.md
  • src/content/docs/Technology/Cross-Chain Arhitecture.md
  • src/content/docs/03_Native Asset Mapping.md (rewrite SOL examples as BTC)
  • src/content/docs/Roles/dapp-users.md
  • src/content/docs/Roles/developers.md (3 corrections)
  • src/content/docs/using-vsc.md (2 corrections)

Status framing throughout: live = Bitcoin, Ethereum, Hive.
Planned = Litecoin, Dash, Solana.

Verification

  • pnpm run build produces dist/llms.txt with the corrected description
  • After deploy: curl https://docs.magi.eco/llms.txt should reflect the new wording

@vercel

vercel Bot commented May 25, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview, Comment May 25, 2026 1:49pm

Request Review

@AndreaRaccagni
AndreaRaccagni merged commit d94f589 into main May 25, 2026
3 checks passed
@AndreaRaccagni
AndreaRaccagni deleted the docs/align-with-codebase branch May 25, 2026 13:49
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.

1 participant