How to Contribute
redteams.ai is an open knowledge base built by the AI security community. Whether you're fixing a typo or writing a full guide, your contributions help make AI red teaming knowledge more accessible.
Ways to Contribute
Write Content
Author new guides, tutorials, or reference pages on AI red teaming topics. We welcome deep dives into techniques, tooling, and case studies.
Fix Errors
Spot an inaccuracy, typo, or outdated reference? Submit a pull request with corrections. Every improvement matters.
Report Issues
Found a broken link, rendering bug, or missing information? Open a GitHub issue so we can track and fix it.
Suggest Topics
Have an idea for a topic we should cover? Open a discussion or issue to propose new content areas.
Content Guidelines
MDX Format
All content is written in MDX (Markdown with JSX support). Each page lives in the content/ directory.
Frontmatter Fields
Every MDX file requires frontmatter at the top:
--- title: "Page Title" description: "A concise description for SEO and previews." difficulty: beginner | intermediate | advanced | expert tags: [tag1, tag2] last_updated: "YYYY-MM-DD" sidebar_position: 1 ---
File Structure
content/
_meta.json # Navigation ordering
topic-name/
_meta.json # Section ordering
index.mdx # Section landing page
subtopic.mdx # Individual article
blog/
my-post.mdx # Blog postWriting Style
- •Be precise and technical. Assume readers have security background. Avoid unnecessary simplification.
- •Use active voice.Write "The attacker crafts a prompt" not "A prompt is crafted by the attacker."
- •Include concrete examples. Show real techniques, payloads, and outputs where appropriate.
- •Cite sources. Link to papers, blog posts, and repositories when referencing research.
Getting Started
Fork the Repository
Fork the redteams-wiki repo on GitHub to your own account.
Create a Branch
Create a descriptive branch name, e.g. add/mcp-attack-vectors or fix/prompt-injection-typo.
Write Your Content
Add or edit MDX files in the content/ directory following the content guidelines below.
Submit a Pull Request
Push your branch and open a PR. Include a brief summary of your changes and any relevant context.