docs: getting started, overview, command line, library API - #13
Closed
201815054 wants to merge 3 commits into
Closed
docs: getting started, overview, command line, library API#13201815054 wants to merge 3 commits into
201815054 wants to merge 3 commits into
Conversation
Adds four pages under docs/, and a one-line index in the README. getting-started first run in five minutes, from the release package overview what the library is; structure as code, weights as a file using-the-cli every vision-cli command and option, one section per task using-the-library the load/compute pattern, per-model entry points, bindings The repository had a README and a model implementation guide, and nothing in between: no page for someone who has never run anything, no reference for the CLI options, and nothing showing how to call the models from an application. Pages are separated by what the reader is doing -- learning, doing, looking something up, understanding -- rather than by subsystem. Every internal link and anchor resolves, every referenced path exists, and the getting-started commands were run as written. No source files are touched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
This was referenced Aug 6, 2026
Removes bold and italic markers from the prose in the four guides. Structure -- headings, tables, code, links, lists -- is untouched; only the markers a reader sees as noise when looking at the source are gone. README.md is upstream's and keeps its own conventions. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
The previous pass worked line by line, so it missed emphasis spanning two lines and the asterisk form of italics. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Collaborator
Author
|
Closing while a larger issue is investigated: with a trained checkpoint the pipeline does not reproduce the reference detections. Reproduced on main, so it predates these changes, but there is no point reviewing documentation for a flow whose end-to-end correctness is in question. |
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.
Four pages under
docs/, and a one-line index in the README.getting-startedoverviewusing-the-cliusing-the-libraryWhy
The repository had a README and a model implementation guide, and nothing in between. There was no page for someone who has never run anything, no reference for the CLI options, and nothing describing how to call the models from an application — which is the ordinary way to use the library.
Pages are separated by what the reader is doing rather than by subsystem: learning, doing, looking something up, understanding. A tutorial that stops to explain the design, or a reference that turns into a walkthrough, serves neither reader.
getting-starteduses BiRefNet rather than the README's MobileSAM example, because it needs no prompt coordinates to explain and produces a result you can look at in one command.Verification
postproc.h,tracker.handvision.h.No source files are touched. Independent of #11 and #12.
🤖 Generated with Claude Code