docs: add paste-to-install path and route contact by purpose - #29
Merged
Merged
Conversation
Each skill is now its own directory at the repo root, so the whole catalogue is visible from the repository listing instead of being buried two levels down under skills/security/<domain>/. 38 skills move: 8 axguard-* orchestration skills and 30 security domain skills. All moves are renames, so history follows. Domain grouping is not lost — ai, application, discovery, identity, infrastructure and operations survive in the domain: field of the registry, which moves from skills/index.yaml to skills-index.yaml at the root. install.sh and uninstall.sh now discover skills by globbing top-level directories that contain a SKILL.md. Both previously carried the list by hand, and uninstall.sh had drifted: it omitted the axguard-security skill and the axguard-contribute.md and axguard-privacy.md commands, so those were left behind on removal. Deriving both lists from the repo fixes that and stops it recurring. validate_skills.py identified domain skills by their skills/security/ path. That signal is gone, so it now treats any skill not named axguard-* as a domain skill — the same 30/8 split — and keeps enforcing version, domain, license, ## Purpose and ## Research Provenance on them. test_skills.py asserted exactly 30 entries matching path: skills/security/. It now asserts every skill on disk is registered in skills-index.yaml, which is a stronger check and layout-independent.
Lead the quick start with a single block a user pastes into Claude Code. The agent clones, runs install.sh, sets up the virtualenv and writes the AXguard section into CLAUDE.md itself, so getting started is one paste instead of six commands. The manual steps stay below it for anyone who wants them. Route the three addresses by what they are for rather than listing them side by side: hello@ for questions and bugs, b2b@ for sponsorship, partnership and commercial, shuvon@ to reach the founder. Add the same routing to the header so it is visible without scrolling, and point vulnerability reports at SECURITY.md instead of a public issue. Drop the eight status badges from the header.
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.
Three changes to the README.
1. One paste to install
The quick start now opens with a block you paste into Claude Code, and the agent does the rest — clone,
install.sh, virtualenv,pip install -e ., and writing the AXguard section into yourCLAUDE.mdwith all 31 commands listed. It ends by asking whether you also want the other agents via./install.sh --agent all.Getting started is one paste instead of six commands. The manual steps are kept directly underneath for anyone who prefers them, so nothing is lost.
2. Contact routed by purpose
The three addresses were listed side by side with no indication of which to use. Now each one says what it is for:
The same routing goes in the header, so it is visible without scrolling to the bottom. The funding section now names sponsorship as the thing that keeps the project free and points it at
b2b@.Vulnerability reports in AXguard itself are pointed at
SECURITY.mdrather than a public issue — that file already exists and was not linked from the README.3. Badges removed
Dropped the eight header badges: MIT, Python 3.10+, Version, CI, CodeQL, OpenSSF Scorecard, Claude Code, Cursor.
Worth knowing what goes with them: the CI, CodeQL and OpenSSF Scorecard badges were live build status, not decoration, and for a security tool they are the fastest signal that the project tests and scans itself. The Scorecard one in particular is a supply-chain trust marker. Easy to restore if you want any of them back — the workflows and the Scorecard listing are unchanged.
The three identity badges in Credits (GitHub, shuvonsec.com, AwareXone) are untouched.
Verification
.github/SECURITY.mdconfirmed present before linking it.img.shields.ioreferences left in the header; the three in Credits are intentional.