Skip to content

fix: simplify crate landing docs#8

Merged
f0rr0 merged 1 commit into
mainfrom
f0rr0/simplify-readme-docs
Apr 26, 2026
Merged

fix: simplify crate landing docs#8
f0rr0 merged 1 commit into
mainfrom
f0rr0/simplify-readme-docs

Conversation

@f0rr0
Copy link
Copy Markdown
Owner

@f0rr0 f0rr0 commented Apr 26, 2026

Summary

  • reduce README to a simple landing page focused on use cases, install, and happy paths
  • keep the main install path to pglite-oxide plus serde_json; anyhow is not required
  • keep the SQLx compatibility example with its own optional SQLx/Tokio setup
  • move detailed API, runtime/performance, and development material into separate docs
  • keep public docs links absolute so they work from package renderers as well as GitHub

Verification

  • cargo test --doc --locked
  • cargo package --locked --allow-dirty --list includes README and the public docs
  • cargo metadata --no-deps --format-version 1 confirms readme = "README.md" and docs.rs metadata
  • git diff --check

Release note

This uses a fix: title intentionally: the README is part of the published crate package, so the simplified public docs need a patch release to become visible on package pages.

@f0rr0 f0rr0 force-pushed the f0rr0/simplify-readme-docs branch 2 times, most recently from ead0a71 to a99aed9 Compare April 26, 2026 10:07
@f0rr0 f0rr0 force-pushed the f0rr0/simplify-readme-docs branch from a99aed9 to 82d3c9e Compare April 26, 2026 10:09
@f0rr0 f0rr0 merged commit e56479c into main Apr 26, 2026
4 of 5 checks passed
@f0rr0 f0rr0 deleted the f0rr0/simplify-readme-docs branch April 26, 2026 10: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