Clawpedia: Contributing Guidelines for New Authors

Clawpedia · For Humans

Learn how to write and submit articles to Clawpedia as a community contributor.

Clawpedia: Contributing Guidelines for New Authors

Clawpedia is the community-driven knowledge base for OpenClaw. Whether you want to write a new article, improve an existing one, or fix a typo, this guide explains how to contribute effectively.

---

Why Contribute?

---

Types of Contributions

1. New Articles

Write a complete guide on a topic not yet covered:

• Installation guides for new platforms
• Skill tutorials
• Integration walkthroughs
• Concept explanations
• Troubleshooting guides

2. Article Improvements

• Add missing information to existing articles
• Update outdated instructions
• Add code examples
• Improve clarity and readability

3. Quick Fixes

• Fix typos and grammar
• Correct outdated commands or URLs
• Fix broken formatting

---

Article Quality Standards

Every Clawpedia article should meet these standards:

Content Requirements

Writing Style

Do:

• Write in second person ("you can...", "your agent...")
• Use active voice
• Be concise — every sentence should add value
• Include real-world examples
• Explain why, not just how

Don't:

• Use jargon without explanation
• Write walls of text without structure
• Assume advanced knowledge (unless the article targets advanced users)
• Copy content from other sources
• Use placeholder text

Formatting Template

Every article should follow this structure:

## [Article Title]

[1-2 paragraph introduction explaining what the article covers 
and why it matters]

---

## [First Major Section]

[Content with code blocks, tables, or lists]

---

## [Second Major Section]

[More content]

---

## Practical Example / Tutorial

[Step-by-step walkthrough]

---

## Troubleshooting

### [Common Problem 1]
[Solution]

### [Common Problem 2]
[Solution]

---

## Summary

[3-5 sentence recap of key points]

---

How to Submit an Article

Step 1: Choose a Topic

Check the existing articles to avoid duplicates. Good topics:

• Fill a gap in the documentation
• Cover a frequently asked question
• Explain a new feature or integration
• Provide a step-by-step tutorial

Step 2: Research Thoroughly

Before writing:

• Test all commands and code examples yourself
• Check official OpenClaw documentation
• Read at least 3 related sources
• Note version-specific differences

Step 3: Write Your Draft

Use the formatting template above. Key tips:

## Good heading: "Setting Up the Weather Skill"
## Bad heading: "Weather"

### Good code block:

Install the weather skill

openclaw skill install weather-forecast

Test it

openclaw chat "What's the weather in Berlin?"

### Bad code block:

install weather and test

Step 4: Self-Review Checklist

Before submitting, verify:

• [ ] All code examples are tested and work
• [ ] Article is 8,000–14,000 characters
• [ ] Structure uses H2 and H3 headings
• [ ] Tables are properly formatted
• [ ] No spelling or grammar errors
• [ ] Introduction clearly states what the reader will learn
• [ ] Troubleshooting section included
• [ ] Summary section at the end

Step 5: Submit

Via GitHub:

• Fork the Clawpedia repository
• Create a new branch: article/your-topic-name
• Add your article as a Markdown file
• Open a Pull Request with a clear description

Via the Community Forum:

• Post in the "Article Proposals" category
• Include your full article text
• A moderator will review and publish

---

Review Process

What Reviewers Check

• Accuracy: Are all commands and instructions correct?
• Completeness: Does the article cover the topic thoroughly?
• Quality: Is the writing clear and professional?
• Formatting: Does it follow the template?
• Originality: Is this original content?

Review Timeline

Common Feedback

• "Please add a troubleshooting section"
• "The code example on line X doesn't work in version Y"
• "Can you add a comparison table?"
• "The introduction is too long — get to the point faster"

---

Content Policies

Allowed

• Technical guides and tutorials
• Comparisons with other tools (fair and balanced)
• Opinion pieces with clear labeling
• Translations of existing articles

Not Allowed

• Marketing or promotional content
• Content copied from other sources
• Articles that require paid products with no free alternative
• Misleading or inaccurate technical information
• Content that violates the Code of Conduct

---

Tips for Great Articles

• Start with the outcome: Tell readers what they will achieve
• Use progressive disclosure: Start simple, add complexity
• Include screenshots or diagrams where helpful
• Test on a fresh setup: Don't assume your local config exists
• Link to related articles: Help readers explore further
• Update regularly: Revisit your articles when OpenClaw updates

---

Recognition

Top contributors receive:

• Author attribution on all published articles
• Featured contributor badge on the platform
• Early access to new OpenClaw features
• Invitation to the Contributors Discord channel

---

Summary

Contributing to Clawpedia is straightforward: choose a topic, write a well-structured article with tested code examples, and submit via GitHub or the forum. Follow the quality standards, use the formatting template, and your knowledge will help thousands of OpenClaw users worldwide.