mirror of
https://github.com/prompt-security/clawsec.git
synced 2026-06-13 05:28:02 +03:00
Add comprehensive documentation for ClawSec modules and workflows (#75)
- Introduced glossary for key terms and definitions related to security advisories, skill packaging, and CI/CD processes. - Documented the Automation and Release Pipelines module, detailing responsibilities, key files, public interfaces, and configuration. - Added ClawSec Suite Core module documentation, outlining its responsibilities, key files, public interfaces, and configuration. - Created Frontend Web App module documentation, covering responsibilities, key files, public interfaces, and configuration. - Added Local Validation and Packaging Tools module documentation, detailing responsibilities, key files, public interfaces, and configuration. - Documented NanoClaw Integration module, including responsibilities, key files, public interfaces, and configuration. - Introduced an overview of ClawSec, including purpose, repo layout, entry points, key artifacts, and workflows. - Added a Security section outlining the security model, cryptographic controls, runtime enforcement, and incident playbooks. - Created a Testing section detailing the testing strategy, verification layers, CI workflow coverage, and local testing commands. - Documented the Workflow section, covering the end-to-end lifecycle, primary workflow map, local operator workflow, and operational risks.
This commit is contained in:
@@ -0,0 +1,43 @@
|
||||
# Wiki Index
|
||||
|
||||
## Summary
|
||||
- Purpose: Document ClawSec as a combined web catalog, signed advisory channel, and multi-skill security distribution system.
|
||||
- Tech stack: React 19 + Vite + TypeScript frontend, Node/ESM scripts, Python utilities, Bash automation, GitHub Actions pipelines.
|
||||
- Entry points: `index.tsx`, `App.tsx`, `scripts/prepare-to-push.sh`, `scripts/populate-local-feed.sh`, `scripts/populate-local-skills.sh`, workflow files under `.github/workflows/`.
|
||||
- Where to start: Read [Overview](overview.md), then [Architecture](architecture.md), then module pages for the area you are editing.
|
||||
- How to navigate: Use Guides for cross-cutting concerns, Modules for implementation boundaries, and Source References at the end of each page to jump into code.
|
||||
|
||||
## Start Here
|
||||
- [Overview](overview.md)
|
||||
- [Architecture](architecture.md)
|
||||
|
||||
## Guides
|
||||
- [Dependencies](dependencies.md)
|
||||
- [Data Flow](data-flow.md)
|
||||
- [Configuration](configuration.md)
|
||||
- [Testing](testing.md)
|
||||
- [Workflow](workflow.md)
|
||||
- [Security](security.md)
|
||||
|
||||
## Modules
|
||||
- [Frontend Web App](modules/frontend-web.md)
|
||||
- [ClawSec Suite Core](modules/clawsec-suite.md)
|
||||
- [NanoClaw Integration](modules/nanoclaw-integration.md)
|
||||
- [Automation and Release Pipelines](modules/automation-release.md)
|
||||
- [Local Validation and Packaging Tools](modules/local-tooling.md)
|
||||
|
||||
## Glossary
|
||||
- [Glossary](glossary.md)
|
||||
|
||||
## Generation Metadata
|
||||
- [Generation Metadata](GENERATION.md)
|
||||
|
||||
## Source References
|
||||
- README.md
|
||||
- App.tsx
|
||||
- package.json
|
||||
- scripts/prepare-to-push.sh
|
||||
- scripts/populate-local-feed.sh
|
||||
- scripts/populate-local-skills.sh
|
||||
- skills/clawsec-suite/skill.json
|
||||
- .github/workflows/ci.yml
|
||||
Reference in New Issue
Block a user