Skip to content

docs: fix incorrect crate names, versions, and non-existent CLI subcommand#14

Merged
urmzd merged 1 commit intomainfrom
docs/fix-readme-documentation
Mar 29, 2026
Merged

docs: fix incorrect crate names, versions, and non-existent CLI subcommand#14
urmzd merged 1 commit intomainfrom
docs/fix-readme-documentation

Conversation

@urmzd
Copy link
Copy Markdown
Owner

@urmzd urmzd commented Mar 29, 2026

Summary

  • Fix cargo run -p lgpcargo run -p lgp-core for examples (core library's package name is lgp-core, not lgp)
  • Update core library README: correct crate name (lgp-core), version (1.31.6), crates.io badge, and replace fabricated Quick Example with actual working API
  • Remove documented lgp example subcommand from CLI README (subcommand doesn't exist)
  • Disambiguate Packages table in root README (lgplgp-core for the core library)

Test plan

  • Pre-commit hooks pass (rustfmt, clippy)
  • All tests pass
  • Verify cargo run -p lgp-core --example iris_classification works
  • Verify cargo run -p lgp-core --example cart_pole --features gym works

…mmand

- Fix `cargo run -p lgp` to `cargo run -p lgp-core` for examples (lgp-core is the core library package name)
- Disambiguate Packages table: label core library as lgp-core
- Update crates.io badge and install instructions to use lgp-core
- Update version from 1.3 to 1.6 in core library README
- Replace fabricated Quick Example with actual working API usage
- Remove documented `lgp example` subcommand that doesn't exist
- Fix examples path in core library README
@urmzd urmzd merged commit c97310f into main Mar 29, 2026
2 checks passed
@urmzd urmzd deleted the docs/fix-readme-documentation branch March 29, 2026 23:06
urmzd added a commit that referenced this pull request Mar 30, 2026
docs: fix incorrect crate names, versions, and non-existent CLI subcommand
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