Onboarding
Documentation Templates
Standardized templates for creating new documentation pages.
To ensure consistency across the Matador documentation, please use the following templates when contributing new content.
Templates
Use this for documenting Contracts, Modules, or CLI commands.
---
title: [Component Name]
description: Technical reference for [Component].
---
import { Callout } from 'fumadocs-ui/components/callout';
## Overview
[Brief description of functionality.]
## Interface
```solidity
interface IMyComponent {
function doSomething() external;
}
```
## Methods
### `doSomething`
Executes the logic.
| Parameter | Type | Description |
| :--- | :--- | :--- |
| `arg1` | `uint256` | The first argument. |
<Callout title="Note" type="info">
Important implementation detail.
</Callout>Use this for conceptual explanations or workflows.
---
title: [Topic Name]
description: How to [Action].
---
import { Steps, Step } from 'fumadocs-ui/components/steps';
## Introduction
[Why this matters.]
## The Process
<Steps>
<Step>
### Step 1
Do this first.
</Step>
<Step>
### Step 2
Then do this.
</Step>
</Steps>Use this for documenting Protocol Integrations.
---
title: [Protocol] Integration
description: Securing [Protocol] interactions with Matador.
---
## Security Architecture
[Mermaid diagram of the flow]
## Permission Patterns
### Pattern 1: [Name]
```solidity
permission Pattern1 -> 1.0.0 {
// ...
}
```
## Integration Checklist
- [ ] Verified ABI
- [ ] Checked Contract AddressWriting Guidelines
- Tone: Professional, precise, yet accessible. Avoid slang.
- Code Blocks: Always specify the language (
solidity,bash,typescript) for syntax highlighting. - Titles: Use title case for headings.
- Links: Use relative links for internal navigation (
/docs/guides/security).