docs: add FAQ, document in-memory model loading; bump version to 0.8.0#154
Conversation
- Add docs/FAQ.md (Windows MSVC linker requirements from #105, GPU vs CPU expectations for PP-OCRv6 from #151) and link it from the README. - Mention in-memory model loading in the README and crate docs, and note in docs/models.md that in-memory sources bypass auto-download path resolution. - Bump workspace version to 0.8.0: #153 changed the AdapterBuilder::build signature, which is a breaking API change.
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 12b19389b5
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| [workspace.package] | ||
| version = "0.7.5" | ||
| version = "0.8.0" |
There was a problem hiding this comment.
Update the lockfile with this version bump
Because this bumps the workspace crates to 0.8.0 while leaving the tracked Cargo.lock entries for oar-ocr, oar-ocr-core, oar-ocr-derive, and oar-ocr-vl at 0.7.5, locked builds now fail before compiling. I verified cargo check --workspace --locked --no-default-features exits with cannot update the lock file ... because --locked was passed, and cargo check --help defines --locked as asserting that Cargo.lock remains unchanged; regenerating and committing the lockfile keeps consumers/CI jobs that use locked builds working.
Useful? React with 👍 / 👎.
There was a problem hiding this comment.
Cargo.lock is not tracked in this repository — it is listed in .gitignore (line 8), and neither main nor this branch contains it (git cat-file -e main:Cargo.lock fails). This is a library workspace, so consumers generate their own lockfile and no CI job here uses --locked. No change needed.
|
Warning Gemini encountered an error creating the review. You can try again by commenting |
Summary
Documentation follow-ups for #153 plus the version bump for the next release.
docs/FAQ.md, linked from the README's Documentation section, seeded with the two most-asked issues:LNK2001 __std_find_trivial_8→ VS 2022 (MSVC v143) requirement (Exemple not works #105)docs/models.mdthat in-memory sources bypass auto-download path resolution (all pointing to the existingdocs/usage.mdsection).AdapterBuilder::buildsignature (&Path→impl Into<ModelSource>), which is a breaking API change, so the next release must be a minor bump under pre-1.0 semver.Testing
cargo check --workspace(no warnings),cargo fmt --all --check🤖 Generated with Claude Code