Skip to content

docs: fix CONTRIBUTING first-run path and rustapi-rs crates.io README - #260

Merged
Tuntii merged 1 commit into
mainfrom
cursor/docs-contributing-readme-1953
Aug 15, 2026
Merged

docs: fix CONTRIBUTING first-run path and rustapi-rs crates.io README#260
Tuntii merged 1 commit into
mainfrom
cursor/docs-contributing-readme-1953

Conversation

@Tuntii

@Tuntii Tuntii commented Aug 15, 2026

Copy link
Copy Markdown
Owner

Fixes the two Show HN docs blockers: a dead first-run path in CONTRIBUTING, and a mixed-language / stale-version Quick Start on the crate README that crates.io publishes.

Description

A first-time contributor following CONTRIBUTING.md was told to ls examples/ and cargo run -p hello-world. Those workspace packages are gone. The live path is crates/rustapi-rs/examples/ and cargo run -p rustapi-rs --example golden_path (same command as docs/GOLDEN_PATH.md).

crates/rustapi-rs/README.md is what crates.io shows for rustapi-rs 0.2.0. The Quick Start mixed leftover Turkish copy with English and still had a version = "0.1" + features = ["full"] snippet next to the 0.2.0 path. That section is now one English 0.2.0 install (crate name + optional api alias), matching docs/GETTING_STARTED.md. The rest of the crate README is unchanged.

No code or feature changes.

Type of Change

  • Documentation update

Related Issues

Fixes #258, Fixes #259

Testing

  • ls crates/rustapi-rs/examples/ lists golden_path.rs (and the other in-crate examples)
  • cargo run -p rustapi-rs --example golden_path builds and serves
  • GET /api/v1/ping{"status":"ok"}
  • GET /live → healthy probe JSON
  • GET /docs/openapi.json returns a spec
  • crates/rustapi-rs/README.md Quick Start is English-only, pins 0.2.0, and has no Turkish leftover / 0.1 + full snippet

Additional Notes

The stale CONTRIBUTING paths were leftover from when examples were workspace member crates under a root examples/ directory, not from a pre-workspace layout. The project-structure tree now matches current crates/ (rustapi-mcp, rustapi-grpc, rustapi-testing) and drops the old root examples/, benches/, and memories/ entries.

Open in Web Open in Cursor 

Point Running Examples at crates/rustapi-rs/examples and golden_path.
Refresh the crate map to match the current workspace. Rewrite the
crates.io Quick Start to one English 0.2.0 install path.

Fixes #258
Fixes #259

Co-authored-by: Tunay <Tuntii@users.noreply.github.com>
@github-actions github-actions Bot added the docs label Aug 15, 2026
@Tuntii
Tuntii marked this pull request as ready for review August 15, 2026 19:40
@Tuntii
Tuntii merged commit a4c6019 into main Aug 15, 2026
9 checks passed
@Tuntii
Tuntii deleted the cursor/docs-contributing-readme-1953 branch August 15, 2026 19:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

docs: English-only rustapi-rs README for crates.io docs: fix CONTRIBUTING first-run path and crate map

2 participants