Skip to main content

Contribution guide

The Espressif Developer Portal is an open-source project maintained on GitHub.

You, dear community members, are very welcome to collaborate on the portal and contribute in any way. Among the possible contribution scenarios, the most popular one is likely contributing content, such as blog articles or workshops.

Before you start writing content, consider the following:

  • Decide how you want to contribute by choosing the contribution workflow
  • To see your content rendered in HTML, decide how to preview the website:
    • In your pull request: CI builds a preview automatically every time changes are pushed
    • In your local environment: You can install Hugo (supported versions are in the README badges) and go through its Getting started if required. If you have any build issues, see Preview in HTML

To write and publish content, follow these guides: