Skip to content

docs: match README and CONTRIBUTING to what the repo contains - #10

Open
oa-sarvesh wants to merge 4 commits into
mainfrom
docs/fix-overclaims
Open

oa-sarvesh wants to merge 4 commits into
mainfrom
docs/fix-overclaims

Conversation

@oa-sarvesh

Copy link
Copy Markdown
Contributor

Summary

The README and CONTRIBUTING describe things that aren't in the repo today: a Sui Move package (live/sui/otas_live), a live runner (live/runner), testnet runs, and Mysten's PAS as a git submodule. This brings the text in line with the code.

Type of change

  • Schemas or reason-code registry
  • Conformance vectors or Python tools
  • Simulated demo
  • EVM contracts (live/evm)
  • Sui Move package (live/sui)
  • Live runner (live/runner)
  • Scripts or CI
  • Documentation
  • Other:

Related issues

None.

Details

.gitmodules only has forge-std, and the Sui leg exists only as the simulated SuiRail in tools/otas_tools/rails.py.

  • README: drop "runs on testnet" from the contribution list; forge-std is the only submodule.
  • CONTRIBUTING: describe Flow A as a simulation plus EVM contracts with Foundry tests; remove the Sui package, live runner and artifact-rebuild steps; swap "run the live demo on testnet" for "port the contracts to Sui Move".
  • rails.py / cli.py: two comments that pointed at live/sui and live/runner. Comments only, no code change.

Checklist

  • All commits are signed off for DCO (git commit -s)
  • My git name/email match my sign-off and GitHub account
  • This targets main
  • CI is green
  • No private keys, .keys/ files or other secrets are included

Notes for reviewers

Checked locally on the same changes: validate-all OK, run-vectors 10/10, and the demo runs and reconciles with 0 schema violations.

Not in this PR: the issue and PR templates still list live/sui, live/runner and "Sepolia × Sui testnet". I'll do those separately. The repo description also says "running live on Sepolia × Sui testnet"; that's a setting, so I'll change it by hand. If a Sui package or runner is added later, the removed lines are easy to bring back.

Signed-off-by: oa-sarvesh <sarvesh@openassets.to>
Signed-off-by: oa-sarvesh <sarvesh@openassets.to>
Signed-off-by: oa-sarvesh <sarvesh@openassets.to>
Signed-off-by: oa-sarvesh <sarvesh@openassets.to>
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