Skip to content

docs: make root README user-facing - #31

Merged
swgiacomelli merged 1 commit into
mainfrom
docs/user-facing-readme
Aug 22, 2026
Merged

swgiacomelli merged 1 commit into
mainfrom
docs/user-facing-readme

Conversation

@swgiacomelli

Copy link
Copy Markdown
Contributor

Summary

  • lead with the user value and the target/host crate choice
  • add installation, a compile-checked typed conversion, and runnable examples
  • make features, numeric guarantees, scope, compatibility, and verification easy to scan
  • retain crates.io and docs.rs badges using their post-publication URLs

Documentation authority

Reviewed against Photon Circus Repository Standards at edde2dd4497183da168f56297ba82f381c86e0cc.

Verification

  • exact quick-start snippet compiled and passed as a temporary integration test
  • all three documented example commands ran successfully
  • all repository-relative links resolve
  • cargo xtask ci: all runnable checks passed, no skips

Live publishing state

Both crates are available on crates.io. The docs.rs endpoints are still queued and currently return 404; the canonical badge and documentation URLs are already in place and will resolve when docs.rs finishes the builds.

@swgiacomelli
swgiacomelli merged commit f0350bb into main Aug 22, 2026
1 check passed
@swgiacomelli
swgiacomelli deleted the docs/user-facing-readme branch August 22, 2026 18:12
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