docs: OSS-style README, brand banner, and user guide under docs/guide#67
Merged
Conversation
Rework the repo's front door for readers coming from the talk, modeled on
the READMEs of fastify, gin, cobra, charm, and kubernetes:
- README: centered brand banner + tagline + badge row, then what/why,
a compact quickstart, features, the channel table, built-in skills,
and a docs link list. Reference material moved out to the guide; no
internal companion docs cited. Slack is now marked as planned (only
github/mcp/tui channels exist today).
- brand: argus-banner-{light,dark}.svg lockups (feather + wordmark +
"application security agent"), picked by <picture> per color scheme.
- docs/guide/: new task-oriented user guide — getting started,
configuration reference, GitHub and MCP channel guides, skills guide,
and the kubernetes page moved under deployment/.
- docs/design/: authz-skill-design*.md moved out of docs root.
- docs/skills/ removed: the authz-audit companion README duplicated the
design doc and the new skills guide, and it cannot live next to the
skill itself because go:embed all:builtin would bundle it into the
binary as a skill file.
All relative markdown links verified to resolve.
Co-Authored-By: Claude Fable 5 <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
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
Reworks the repo's front door in the style of well-known OSS dev tools (fastify, gin, cobra, charm, kubernetes) and stands up a task-oriented user guide.
README
<picture>, light/dark variants) replaces the H1; tagline + badge row (CI, release, Go Reference, Go Report Card, license — the Go/pkg.go.dev badges light up once the repo is public).github/mcp/tuiexist today, so it is now marked planned.Brand
brand/argus-banner-{light,dark}.svg: feather + wordmark + "application security agent" lockup, system fonts only (no external assets).Docs restructure (by audience)
docs/guide/(new, user-facing): getting started,argus.yamlreference, GitHub channel (auto reviews, bare-name vocative, security posture), MCP channel, skills guide, anddeployment/kubernetes.mdmoved in with links fixed.docs/design/:authz-skill-design*.mdmoved out of the docs root.docs/skills/removed: the authz-audit companion README duplicated the design doc and the new skills guide — and it can't live next to the skill inpkg/skill/builtin/because//go:embed all:builtinwould bundle it into the binary as a skill file. User-facing content now lives indocs/guide/skills.md.CONTEXT.md,docs/adr/,docs/agents/untouched (paths fixed by the grilling conventions).Verification
🤖 Generated with Claude Code