Document credential scanning in the public docs - #342
Merged
Conversation
Argus scans session text for pasted credentials and surfaces the result in several places, but none of it was documented for readers. Add it where each audience would look for it. Sessions gets the main writeup (the banner, the timeline markers, dismissal, the list badge and the Flagged filter), Privacy gets what is stored and what crosses the sync wire, and Terminology gets the glossary entry the rest link to. How It Works, Metric Views, the Hub's Tasks and MCP pages, the local MCP server page, the CLI reference and the settings reference each pick up the part that belongs to them. Says "credential warning" throughout rather than "secret", since the docs already use "secret" for the argus secret API-key store. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
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.
Summary
Argus scans session text for pasted credentials (#327, #336) and surfaces the result in the session banner, the timeline, the session list, the Activity recommendations,
argus statusand the Hub's Tasks view. None of it was documented for readers. This adds it where each audience would look.sessions.mdprivacy.mdterminology.mdhow-it-works.mdmetric-views.mdargus-hub/tasks.mdargus-hub/mcp.mdflaggedfilter onquery_tasksandquery_task_qualitymcp-server.mdcli-reference.mdstatusreports credential-check progresssettings-reference.mdindex refreshNotes
Says "credential warning", not "secret". The published docs already use "secret" for the
argus secretAPI-key store, so a second meaning of that word on the same site would be a trap. This also matches the strings the UI, the CLI and the recommendation already show.No screenshots.
docs/contributing/technical-writing.mdrequires synthesized data, so capturing the banner and the Flagged list against fake fixtures is a follow-up rather than part of this change.No positioning change. This documents a capability without changing how Argus is described, so
docs/contributing/positioning.mdand its surface inventory are untouched. Putting credential scanning into the promise or the canonical descriptions would be a positioning change first.Test plan
bun run docs:buildpasses, so no dead links or bad anchorsdocs/contributing/voice-and-tone.md🤖 Generated with Claude Code