Skip to content

Commit 0eb6839

Browse files
committed
docs(detectors): add comprehensive YAML detector documentation
Add complete user guide for YAML detectors: - Quick start with working examples - Full schema reference with all fields - Event filtering and data extraction guide - Complete list of supported extraction paths - Deployment options and best practices - Troubleshooting guide - Updated detector index with YAML guide link
1 parent f752aca commit 0eb6839

File tree

2 files changed

+646
-2
lines changed

2 files changed

+646
-2
lines changed

docs/docs/detectors/index.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,22 @@ Detectors analyze runtime events to identify security threats and derive higher-
1414

1515
## Documentation
1616

17+
### [YAML Detectors Guide](yaml-detectors.md)
18+
19+
Learn how to create detectors using declarative YAML configuration:
20+
21+
- Quick start with examples
22+
- Complete schema reference
23+
- Event filtering and data extraction
24+
- Threat metadata and auto-population
25+
- Deployment and best practices
26+
- Troubleshooting guide
27+
28+
**Start here** if you want to create detectors without writing Go code.
29+
1730
### [Developer Guide](developer-guide.md)
1831

19-
Complete guide to writing detectors, from quick start to advanced features:
32+
Complete guide to writing Go detectors, from quick start to advanced features:
2033

2134
- Quick start with a working example
2235
- Detector definition and requirements
@@ -29,7 +42,7 @@ Complete guide to writing detectors, from quick start to advanced features:
2942
- Migration from old signature API
3043
- Best practices and real examples
3144

32-
**Start here** if you're writing your first detector or migrating from signatures.
45+
**Use this** if you need advanced features like state management or complex logic.
3346

3447
### [DataStore API Reference](datastore-api.md)
3548

0 commit comments

Comments
 (0)