Skip to content

docs: point agents at describe and fix the --manifest command list - #57

Merged
altaywtf merged 2 commits into
mainfrom
docs/cleanup
Sep 27, 2026
Merged

altaywtf merged 2 commits into
mainfrom
docs/cleanup

Conversation

@altaywtf

Copy link
Copy Markdown
Member

Problem

The Visual Reference Guide said only five commands take --manifest. manifest update and screenshot remove take it too (COMMAND_FLAGS in src/cli.ts). The agent guide kept a hand-maintained list of CLI invocations that duplicated the README and vref describe. In the skill's manifest reference, the heading over the edit and remove examples said "Convert".

Solution

  • The guide now says every command that reads a manifest takes --manifest.
  • The agent guide's command list is replaced with the verify gate and vref describe, which lists commands, flags, --fields values, and error codes.
  • The Effect section matches the wording in the sibling tool repos.
  • Distribution links files in package.json instead of listing the tarball contents.
  • The skill heading is fixed.

Proof

vp check . and skillcheck lint pass. Changed links resolve, and no packaged doc links a file outside the tarball. A docs: commit does not trigger a semantic-release version.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Sep 27, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-09-27T19:09:34.262503Z e34a007 PR opened
ℹ️ 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" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@altaywtf
altaywtf merged commit b228865 into main Sep 27, 2026
6 checks passed
@altaywtf
altaywtf deleted the docs/cleanup branch September 27, 2026 19:13
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