Skip to content

docs: describe CI jobs accurately in README.md - #102

Merged
collinsezedike merged 1 commit into
mainfrom
docs/readme-ci-description
Aug 19, 2026
Merged

docs: describe CI jobs accurately in README.md#102
collinsezedike merged 1 commit into
mainfrom
docs/readme-ci-description

Conversation

@collinsezedike

Copy link
Copy Markdown
Collaborator

Summary

README.md's tech-stack table and project-layout tree described CI as just cargo fmt, shellcheck, cargo clippy, cargo test, and a wasm build, the same stale description CONTRIBUTING.md had before #98 fixed it. Updated both spots to reflect the actual three-job pipeline (test, demo, sdk) and the test job's real step order.

Closes #101

Test plan

  • Docs-only change, no code or CI behavior changes
  • Cross-checked step order and job names against .github/workflows/ci.yml directly

@collinsezedike
collinsezedike merged commit f6c7c5f into main Aug 19, 2026
4 checks passed
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.

[Chore] README.md understates what CI actually gates

1 participant