docs: fix CONTRIBUTING first-run path and rustapi-rs crates.io README - #260
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.mdwas told tols examples/andcargo run -p hello-world. Those workspace packages are gone. The live path iscrates/rustapi-rs/examples/andcargo run -p rustapi-rs --example golden_path(same command asdocs/GOLDEN_PATH.md).crates/rustapi-rs/README.mdis what crates.io shows forrustapi-rs0.2.0. The Quick Start mixed leftover Turkish copy with English and still had aversion = "0.1"+features = ["full"]snippet next to the 0.2.0 path. That section is now one English 0.2.0 install (crate name + optionalapialias), matchingdocs/GETTING_STARTED.md. The rest of the crate README is unchanged.No code or feature changes.
Type of Change
Related Issues
Fixes #258, Fixes #259
Testing
ls crates/rustapi-rs/examples/listsgolden_path.rs(and the other in-crate examples)cargo run -p rustapi-rs --example golden_pathbuilds and servesGET /api/v1/ping→{"status":"ok"}GET /live→ healthy probe JSONGET /docs/openapi.jsonreturns a speccrates/rustapi-rs/README.mdQuick Start is English-only, pins0.2.0, and has no Turkish leftover /0.1+fullsnippetAdditional 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 currentcrates/(rustapi-mcp,rustapi-grpc,rustapi-testing) and drops the old rootexamples/,benches/, andmemories/entries.