Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/espressif/esp-faq

Last synced: 2 days ago
JSON representation

Host: GitHub
URL: https://github.com/espressif/esp-faq
Owner: espressif
License: apache-2.0
Created: 2020-06-19T06:59:40.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2024-09-09T11:53:08.000Z (17 days ago)
Last Synced: 2024-09-18T15:58:13.176Z (8 days ago)
Language: Python
Size: 3.64 MB
Stars: 35
Watchers: 8
Forks: 10
Open Issues: 12
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# ESP-FAQ Framework

[![Documentation Status](https://dl.espressif.com/AE/docs/docs_latest.svg)](https://docs.espressif.com/projects/esp-faq/en/latest/)

* [中文版](./README_CN.md)

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/
* 中文: 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

``` bash
docs
├── _static
│ ├── espressif-logo.svg # Web logo
│ └── theme_overrides.css # Web Style Sheet
├── zh_CN
│ ├── _static # Inline resources
│ ├── instruction # Instruction
│ ├── commercial-faq # Commercial faq
│ ├── 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
├── instruction # Instruction
├── commercial-faq # Commercial faq
├── 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
```

## Resources

* The [esp32.com forum](https://esp32.com/) is a place to ask questions and find community resources.

* [Check the Issues section on github](https://github.com/espressif/esp-faq/issues) 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](https://docs.espressif.com/projects/espressif-esp-faq/en/latest/instruction/document-contribution.html).