Validate and publish content

Table of Contents

Once you have written your content, validate and publish it:

Run local checks to catch common issues
Create a pull request and ask for review
Once you implement review feedback, the content will be published

Validate your content
#

The following local checks are available:

Once you create a feature branch and commit your content, in the project root, run the checks:

bash tools/ci/check_repo_consistency.sh
bash tools/ci/check_article_details.sh

Use pre-commit
#

This feature is work-in-progress.

This project has a pre-commit hook that can perform the following checks:

Enforce coding standards and best practices in the project’s codebase
Check links using lychee
- Important: this check requires Docker as a dependency, please make sure it is installed

If you want to use pre-commit, in your project folder, run:

# Install requirements
pip install -r requirements.txt
# Set up git hook scripts
pre-commit install
# Remove git hook scripts (if not needed)
pre-commit uninstall

Ask for review
#

To publish your content on the Espressif Developer Portal, please create a pull request on espressif / developer-portal and invite reviewers from Espressif so that they can make sure your content is in line with Espressif’s writing conventions.