docs: report-first README polish - #12
Merged
Merged
Conversation
Presentation only — no behavior, version, or package-contents changes. - Add a terminal-output demo visual above the fold (assets/devcat-report.svg). Generated from a real run of the built CLI against a small curated demo machine and labelled "example output"; the fenced text block below it is byte-identical to the same capture. Referenced by GitHub raw URL so it renders on npm as well as GitHub, and stays out of the npm tarball (the package.json `files` allowlist is unchanged, so the file count is unchanged). - Add an "An inventory, not a security scanner" comparison table framing the two as complementary. No vendor is named and the scanner column is hedged; every DevCat cell is verifiable in this codebase — the report path imports no network or auth code, nothing in src spawns a process, and the manifest parsers keep only config keys. - Move all profile-sync and device-auth documentation into one section near the bottom, retitled to state up front that sync is paused while devcat.dev is rebuilt. The sync-only environment variables and the keychain troubleshooting entry move with it; the top of the README is now purely the local report. No sync code or docs were deleted. - Delete the dead .github/workflows/agent-pr-gate.yml, left over from the review gate decommissioned fleet-wide on 2026-07-24. Nothing references it and the repo ruleset carries no required status checks. ci.yml is untouched. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
AnobleSCM
marked this pull request as ready for review
August 3, 2026 03:57
|
Caution The consumer version of Gemini Code Assist on GitHub has been sunset. All code review activity has officially ceased. |
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.
Presentation only. Zero behavior changes — no code, no version bump, no publish, no package-contents change, no repo settings touched.
1. Demo visual above the fold
assets/devcat-report.svgnow sits directly under the intro line.The content is real output, not a mock-up: the built CLI was run against a small curated demo machine (a clean
HOMEwith a representative tool set), captured through a PTY so colour was emitted, and rendered to a static SVG. It is labelled "Example output" in the README because the machine is curated rather than anyone's real one.Two things worth noting:
diffclean, including the13 locations checked/2 project-scoped · 21 user-widefooter). No numbers were invented or adjusted. That block is retained inside a<details>as the text fallback for screen readers and text-mode viewers.assets/is outside thepackage.jsonfilesallowlist, so it does not enter the tarball and the file count is unchanged. The raw URL resolves once this merges tomain.No terminal-recording tooling and no CI were added — the SVG was produced by a throwaway local script that is not part of this repo.
2. Comparison box
New section, "An inventory, not a security scanner", framed as different job, complementary — it closes by pointing readers at a scanner for safety questions. No vendor is named and nothing is disparaged; the scanner column is deliberately hedged ("often", "may").
Every DevCat cell was checked against source rather than asserted:
src/manifest/*→src/ui/report.tsrunReportimports no auth modulefetchexists only insrc/api/client.ts, unreachable from the report pathchild_process/spawn/execanywhere insrcObject.keys(...)and nothing elseThe DevCat column header is scoped to the
devcatreport so the "no account / no network" cells stay literally true givensyncexists.3. Sync docs consolidated near the bottom
All profile-sync and device-auth documentation now lives in one section titled "Profile sync — paused while devcat.dev is rebuilt", so the pause is visible in the heading itself. Moved in with it: the four sync-only environment variables and the Linux keychain troubleshooting entry (
DEVCAT_DEBUGincluded — it only produces output on the sync and browser-open paths).Nothing was deleted and no sync code was touched. The top of the README is now purely the local report. An explicit
<a id="profile-sync">keeps the pre-existing in-document link working regardless of heading punctuation.4. Dead workflow removed
Deleted
.github/workflows/agent-pr-gate.yml(407 lines), left over from the review gate decommissioned fleet-wide on 2026-07-24.Verified safe before deleting: nothing in the repo references it, and the active
agent-pr-gate-mainruleset carries norequired_status_checksrule (only PR-required, linear history, no-force-push, no-deletion), so removing it strands no check.ci.yml— the 3-OS x 2-Node matrix — is untouched.Gates
All run from the worktree root (pwd-asserted):
npm run lintnpm run buildnpm testnpm pack --dry-runFile count is unchanged — a throwaway
origin/mainworktree was built and packed for comparison and also reported 67 files (49.5 kB). The +0.8 kB is the larger README alone;assets/is excluded by thefilesallowlist. Tarball accounting: 64dist/+README.md+LICENSE+package.json= 67.🤖 Generated with Claude Code