Skip to main content

Documentation Contributors

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

warning

As of block height 31,056,500 (March 26, 2025, 3:00 AM UTC), Celo is no longer a standalone Layer 1 blockchain—it is now an Ethereum Layer 2! Some documentation may be outdated as updates are in progress. If you encounter issues, please file a bug report.

For the most up-to-date information, refer to our Celo L2 documentation.

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. User Guides and Tutorials​

  • Step-by-step tutorials for beginners
  • How-to guides for specific tasks
  • Troubleshooting guides and FAQs
  • Explainer articles for key concepts

3. 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. Navigate to the page you want to edit at docs.celo.org
  2. Click Edit this page at the bottom of the page
  3. Make your changes directly on GitHub
  4. Write a clear commit message describing your changes
  5. Select "Create a new branch and start a pull request"
  6. Describe your changes in the Pull Request (PR)
  7. Tag appropriate reviewers
  8. 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 "sidebars.js" 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
tip

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