esp-faq's Introduction

ESP-FAQ Framework

中文版

ESP-FAQ is a summary document for common problems launched by Espressif.

Hosted Documentation

English: https://docs.espressif.com/projects/espressif-esp-faq/en/latest/ (TODO)
中文: https://docs.espressif.com/projects/espressif-esp-faq/zh_CN/latest/

ESP-FAQ Document framework

language support

The document framework supports reStructuredText and Markdown lightweight markup languages.

Document structure

docs
├── _static
│   ├── espressif-logo.svg       # Web logo
│   └── theme_overrides.css      # Web Style Sheet
├── zh_CN
│   ├── _static                  # Inline resources
│   ├── get-started              # Get started
│   ├── development-environment  # Development environment
│   ├── application-solution     # Application solution
│   ├── hardware-related         # Hardware related
│   ├── software-framework       # Software framework
│   ├── test-verification        # Test verification
│   ├── config.py                # Sphinx config
│   ├── Makefile                 # Compile file
│   └── index.rst                # Home
└── en
    ├── _static                  # Inline resources
    ├── get-started              # Get started
    ├── development-environment  # Development environment
    ├── application-solution     # Application solution
    ├── hardware-related         # Hardware related
    ├── software-framework       # Software framework
    ├── test-verification        # Test verification
    ├── config.py                # Sphinx config
    ├── Makefile                 # Compile file
    └── index.rst                # Home

Document Contribution

Please read the code Document Contribution

Resources

The esp32.com forum is a place to ask questions and find community resources.
Check the Issues section on github if you find a bug or have a feature request. Please check existing Issues before opening a new one.
If you're interested in contributing to ESP-IDF, please check the Contributions Guide.

Recommend Projects