Skip to content

armgit / strix

Public Imported from GitHub
0

Open-source AI penetration testing tool to find and fix your app’s vulnerabilities.

docs: update skills documentation for markdown format

0xallam1b394b808b0a
diff --git a/docs/advanced/skills.mdx b/docs/advanced/skills.mdx
index cbbcad6f..53456008 100644
--- a/docs/advanced/skills.mdx
+++ b/docs/advanced/skills.mdx
@@ -83,35 +83,37 @@ Protocol-specific testing techniques.
## Skill Structure
-Each skill uses XML-style tags for structure:
+Each skill is a Markdown file with YAML frontmatter for metadata:
-```xml
-<vulnerability_guide>
- <title>NAME</title>
-
- <critical>Key insight about this vulnerability</critical>
-
- <scope>What this skill covers</scope>
+```markdown
+---
+name: skill_name
+description: Brief description of the skill's coverage
+---
- <methodology>Step-by-step testing approach</methodology>
+# Skill Title
- <discovery_techniques>How to find it</discovery_techniques>
+Key insight about this vulnerability or technique.
- <exploitation_techniques>How to exploit it</exploitation_techniques>
+## Attack Surface
+What this skill covers and where to look.
- <bypass_techniques>How to bypass protections</bypass_techniques>
+## Methodology
+Step-by-step testing approach.
- <validation>How to confirm findings</validation>
+## Techniques
+How to discover and exploit the vulnerability.
- <false_positives>What to watch out for</false_positives>
+## Bypass Methods
+How to bypass common protections.
- <pro_tips>Additional Expert advice</pro_tips>
-</vulnerability_guide>
+## Validation
+How to confirm findings and avoid false positives.
```
## Contributing Skills
-Community contributions are welcome. Good skills include:
+Community contributions are welcome. Create a `.md` file in the appropriate category with YAML frontmatter (`name` and `description` fields). Good skills include:
1. **Real-world techniques** — Methods that work in practice
2. **Practical payloads** — Working examples with variations
diff --git a/docs/contributing.mdx b/docs/contributing.mdx
index 830ec9bb..14daeb6c 100644
--- a/docs/contributing.mdx
+++ b/docs/contributing.mdx
@@ -50,7 +50,7 @@ Skills are specialized knowledge packages that enhance agent capabilities. They
### Creating a Skill
1. Choose the right category
-2. Create a `.jinja` file with your skill content
+2. Create a `.md` file with YAML frontmatter (`name` and `description` fields)
3. Include practical examples—working payloads, commands, test cases
4. Provide validation methods to confirm findings
5. Submit via PR