Skip to content

docs: README and docs/ to the plugin standard; skill and description match 0.16 (0.16.2) - #29

Merged
mabry1985 merged 2 commits into
mainfrom
docs/standard
Nov 6, 2026
Merged

mabry1985 merged 2 commits into
mainfrom
docs/standard

Conversation

@mabry1985

Copy link
Copy Markdown
Member

Brings Inventory's docs up to the protoAgent plugin standard set by careercoach-plugin, with projectBoard-plugin's reference pages and drift tests. Step 1 of making it a first-class plugin. No behavior change.

README: hero, badges (CI, version, protoAgent, Python, MIT), a plain intro, What you get, How it stays honest, Quick start, a To / Say-or-do table, the docs index and License.

docs/ (new):

Doc What's in it
install.md Requirements, install, settings that matter, first steps, phones
usage.md Each tab and every flow, step by step, including scanning in the home-screen app
how-it-works.md Data model, the agent turns the plugin starts, labels and the public hops, audit
configuration.md Every setting with its default
tools.md Every agent tool
api.md Every route, operator and public
design-decisions.md The why
development.md Layout, tests, the view harness, the fake camera, releasing with the fleet workflow
upgrading.md Behavior notes from 0.5.0 to 0.16.2

Also:

  • Agent skill: skills/inventory-ops adds sale-paste turns, the sealed price in box pricing, label-first binning and Put away, shipping data, and the needs_end rule.
  • Plugin description: the manifest description is rewritten.
  • Design spec: gets a status header saying what shipped and what label first superseded.
  • Version: bumped to 0.16.2.

Drift guard. tests/test_docs_reference.py fails when:

  • a route, agent tool or setting is missing from its reference page, or a removed one is still listed;
  • a documented default drifts from the manifest;
  • a layout-table file doesn't exist;
  • a relative link breaks;
  • the install steps name a CLI subcommand that doesn't exist.

Images use an invented demo inventory, and a scan for personal hostnames, agent ids and real item names came up empty.

Gates: 462 passed; ruff check and format clean.

🤖 Generated with Claude Code

mabry1985 and others added 2 commits November 5, 2026 15:57
The README follows careercoach-plugin's shape: hero, badges, What you get, How it stays honest,
Quick start, a To / Say-or-do table and a docs index. docs/ adds install, usage, how-it-works,
configuration, tools, api, design-decisions, development and upgrading. The hero and phone
shots use an invented demo inventory, never real data.

tests/test_docs_reference.py fails when a route, agent tool or setting isn't in its reference
page (or a removed one still is), when a documented default drifts from the manifest, when a
layout-table file doesn't exist, when a relative link is broken, or when the install steps name
a CLI subcommand that doesn't exist. Same guard as projectBoard-plugin's.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
…(0.16.2)

inventory-ops gains sale-paste turns, the sealed price in box pricing turns, label-first binning
and Put away, shipping data, and the needs_end rule after an off-channel sale. The manifest
description says what the plugin is now. The design spec gets a status header: what shipped and
what label first superseded. Bump 0.16.2.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

@protoreview protoreview Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

QA panel review — PASS

code-review-structural · head f4221cae2473 · formal

Clean docs-only PR: README rewrite, new docs pages, version bump to 0.16.2, skill/manifest description refresh, and a new drift-guard test suite. No findings were raised, so there was nothing to verify. No coverage gaps noted by the panel.

No findings — the review came back clean.

findings JSON (machine-readable)
[]

@protoreview protoreview Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Promoting the PASS verdict for head f4221cae2473: all checks terminal-green, zero unresolved review threads. (approve-on-green)

@mabry1985
mabry1985 merged commit f8b40d5 into main Nov 6, 2026
3 checks passed
@mabry1985
mabry1985 deleted the docs/standard branch November 6, 2026 00:02
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