Fix example document paths in README quickstart - #4439
Open
melbinjp wants to merge 1 commit into
Open
Conversation
Both snippets reference example-docs/layout-parser-paper.pdf and example-docs/layout-parser-paper-fast.pdf. Those files moved under example-docs/pdf/ in 0eb461a (2024-07-18, "refactor: restructure PDF/Image example document organization") and the top-level paths no longer exist, so copying either snippet as written raises FileNotFoundError.
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
No issues found across 1 file
Shadow auto-approve: would auto-approve. Fixes broken example document paths in README quickstart snippets by adding the 'pdf/' segment; a documentation correction with no behavioral or operational impact.
Re-trigger cubic
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
1 participant
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.
The two quickstart snippets in the README point at example documents that have moved.
example-docs/layout-parser-paper-fast.pdf(README line 121)example-docs/layout-parser-paper.pdf(README line 234)Both files live under
example-docs/pdf/since 0eb461a ("refactor: restructure PDF/Image example document organization", 2024-07-18). The top-level paths no longer exist, so copying either snippet as written raisesFileNotFoundError. One of them is in the Docker quickstart, which is a first-run experience for new users.This just adds the
pdf/segment to both. Verified the targets exist atexample-docs/pdf/layout-parser-paper.pdfandexample-docs/pdf/layout-parser-paper-fast.pdfon main.Found by docproof, a documentation checker that verifies claims in docs against the repository and its git history. Hand-checked against the current tree before opening the PR.