Joseph Magly
0c35a833b9
Add user and developer documentation plus Pagenary docsite publishing support. Includes Getting Started, Developer Guide, API and MCP references, Pagenary tenant metadata, npm scripts for sync/build/check/serve, and validation coverage for the generated docsite. Closes #102
51 lines
2.2 KiB
Markdown
51 lines
2.2 KiB
Markdown
# T3MP3ST Documentation
|
|
|
|
Start here when you want to install, run, integrate, or contribute to T3MP3ST.
|
|
|
|
## For Operators
|
|
|
|
| Doc | Use it for |
|
|
|---|---|
|
|
| [Getting Started](GETTING_STARTED.md) | Install, first launch, first safe mission, updates, and troubleshooting |
|
|
| [Scope and Authorization](SCOPE_AND_AUTHORIZATION.md) | Rules of engagement, target receipts, and evidence requirements |
|
|
| [Target Headers](TARGET_HEADERS.md) | Supplying auth headers for an explicitly authorized target origin |
|
|
| [Arsenal Activation Plan](ARSENAL_ACTIVATION_PLAN.md) | Installing optional external tools and understanding adapter readiness |
|
|
| [Team Preview](TEAM_PREVIEW.md) | Ten-minute UI walkthrough for preview builds |
|
|
|
|
## For Developers
|
|
|
|
| Doc | Use it for |
|
|
|---|---|
|
|
| [Developer Guide](DEVELOPER_GUIDE.md) | Architecture, local development, scripts, extension points, and release checks |
|
|
| [API Reference](API_REFERENCE.md) | HTTP server endpoints grouped by workflow |
|
|
| [MCP Guide](MCP_GUIDE.md) | Model Context Protocol setup and the `security_recon` tool |
|
|
| [Contribution Receipts](CONTRIBUTION_RECEIPTS.md) | Evidence template for PRs and claim changes |
|
|
| [Pull Request Delivery](PULL_REQUEST_DELIVERY.md) | Contributor and maintainer PR checklist |
|
|
|
|
Preview this documentation as a Pagenary site:
|
|
|
|
```bash
|
|
npm run docs:serve
|
|
```
|
|
|
|
## Benchmarks And Provenance
|
|
|
|
| Doc | Use it for |
|
|
|---|---|
|
|
| [Verified Provenance](VERIFIED_PROVENANCE.md) | How T3MP3ST ties findings to tool evidence |
|
|
| [XBOW Baseline](XBOW_BASELINE.md) | XBEN benchmark notes |
|
|
| [Cybench](CYBENCH.md) | Cybench benchmark notes |
|
|
| [Wall Forensics](WALL_FORENSICS.md) | Per-challenge misses and benchmark analysis |
|
|
| [Integrity Ledger](INTEGRITY_LEDGER.md) | Contamination audit and retractions |
|
|
| [Obsidivm](OBSIDIVM.md) | Local web range and evaluation notes |
|
|
| [Cognitive Architecture](COGNITIVE_ARCHITECTURE.md) | Prompt and reasoning architecture boundaries |
|
|
| [AI Red-Team Techniques](AI_REDTEAM_TECHNIQUES.md) | Defensive taxonomy and technique map |
|
|
|
|
## Release And Maintenance
|
|
|
|
| Doc | Use it for |
|
|
|---|---|
|
|
| [Install Matrix](INSTALL_MATRIX.md) | OS readiness notes |
|
|
| [Release Checklist](RELEASE_CHECKLIST.md) | Release gates |
|
|
| [Changelog](CHANGELOG.md) | Project change history |
|