Documentation Contributors

Help improve the Celo ecosystem by contributing to documentation and educational resources.

Why Documentation Matters

Documentation contributors play a vital role in the Celo ecosystem by creating clear, accessible resources that help users, developers, and community members understand and use Celo technology. High-quality documentation is essential for adoption, education, and the overall growth of the ecosystem.

Good documentation:

• Lowers barriers to entry for newcomers
• Improves developer experience and productivity
• Empowers users to solve problems independently
• Supports the community by reducing the support burden
• Helps explain Celo’s vision and technical implementation

How You Can Contribute

There are many ways to improve Celo documentation, regardless of your technical expertise:

1. Technical Documentation

• Protocol specifications and architecture guides
• Integration guides and code samples

2. Documentation Maintenance

• Update outdated information
• Fix broken links and references
• Improve organization and navigation
• Enhance readability and clarity

Getting Started

Edit an existing page

To edit an existing page in the documentation:

1. Fork the Celo Docs repository
2. Create a branch naming it after the changes you want to make
3. Write a clear commit message describing your changes
4. Create a Pull Request (PR)
5. Describe your changes in the PR
6. Tag appropriate reviewers
7. Wait for approval and for the site build checks to pass before merging

Add/remove pages

To add a new page to the documentation:

1. Fork the Celo Docs repository
2. Add or delete pages in the appropriate location
3. Create a PR with your changes for the live version of the site
4. Update the “docs.json” file in the main folder:
   • This file controls the navigation menu on the left side of the docs site
   • Add or remove the appropriate files from the list

Content Guidelines

When creating or editing documentation:

• Be accurate: Verify all information, examples, and code snippets
• Be clear: Use simple language and avoid unnecessary jargon
• Be comprehensive: Cover topics thoroughly but concisely
• Be structured: Use proper headings, lists, and formatting
• Be inclusive: Write for a global audience with diverse backgrounds
• Be helpful: Anticipate questions and provide helpful resources

For questions, comments, and discussions please use the Celo Forum or Discord.