docs: document model gotchas and drop stale version example - #60
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.
What
Surgical docs pass — no prose churn.
docs/behavior.md— new Gotchas section (+ TOC entry) documenting three real boundaries of the flat, URL-driven model, framed as by-design:#sha256=)docs/api.md— dropped the hardcoded0.6.0from thebashdep::versionexample so it stops drifting every release.docs/README.md— index Behavior line now lists checksum + parallel + gotchas (was only lockfile/dev-deps/error handling).README.md— matched the Behavior blurb for consistency.Why
The gotchas are the questions a user hits first (filename collisions, "does the lock verify integrity?"). Documenting them up front beats a surprise. The version example was already stale (
0.6.0vs shipped0.7.0).Test plan
Docs-only.
make lint(editorconfig) green; all edited lines within the 100-char cap.