-
Notifications
You must be signed in to change notification settings - Fork 0
Home
Welcome. This wiki is intentionally minimal. Shield's documentation lives in the repo and on our docs site, not here.
| What you want | Where to look |
|---|---|
| Install, quickstart, what it catches, how it decides | README.md |
Shieldset-as-code workflow (PR review, behaviour-diff, golden corpus, --diff mode) |
docs/shieldset-as-code.md |
| 98.4% pass-through methodology | docs/methodology.md |
| How to add a rule, how to file a false positive | CONTRIBUTING.md |
| How to report a security issue | SECURITY.md |
| Community guidelines | CODE_OF_CONDUCT.md |
| Marketing / hosted docs site | https://docs.aperion.ai/aperion-shield.html |
| Latest release notes + binaries | https://github.com/AperionAI/shield/releases/latest |
Shield's docs are version-locked to the release that ships them. Wikis are a single timeline (no per-release branches), so anything that lives here would drift the moment we cut a new tag. We keep docs in /docs/ so they ship with the code, and on docs.aperion.ai for the discoverable marketing-facing version. The wiki tab exists to point you back to those two places.
| What you have | Where it goes |
|---|---|
| A bug, a false-positive report, a feature request | GitHub issue |
| A documentation gap or correction | PR against /docs/ |
| A security report | security@aperion.ai — see SECURITY.md |
| General questions, comparisons, "is Shield right for me" | GitHub Discussions |
If/when the project grows enough community traction to warrant it, we may add:
- Community-curated shieldsets for specific stacks (Postgres-heavy agents, AWS-CDK agents, etc.)
- MCP-server compatibility notes (which upstream MCPs are known-good, which have gotchas)
- FAQ assembled from recurring questions
Until then, the right answer is "see /docs/."
Aperion Shield is Apache-2.0 licensed and free forever for individual developers. Enterprise tier and Smartflow integration: https://aperion.ai.