Skip to content

Commit bd95bc0

Browse files
committed
docs: update quickstart and rename Espressif Audio Development Framework to Espressif Advanced Development Framework
1 parent a554557 commit bd95bc0

File tree

13 files changed

+171
-167
lines changed

13 files changed

+171
-167
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ INSTRUCTIONS
1616

1717
Before submitting a new issue, please follow the checklist and try to find the answer.
1818

19-
- [ ] I have read the documentation [Espressif Audio Development Guide](https://docs.espressif.com/projects/esp-adf/en/latest/index.html) and the issue is not addressed there.
19+
- [ ] I have read the documentation [Espressif Advanced Development Framework Guide](https://docs.espressif.com/projects/esp-adf/en/latest/index.html) and the issue is not addressed there.
2020
- [ ] I have updated my ADF and IDF branch (master or release) to the latest version and checked that the issue is present there.
2121
- [ ] I have searched the issue tracker for a similar issue and not found a similar issue.
2222

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
blank_issues_enabled: false
22
contact_links:
3-
- name: Espressif Audio Development Guide
3+
- name: Espressif Advanced Development Framework Guide
44
url: https://docs.espressif.com/projects/esp-adf/en/latest/index.html
5-
about: This is the documentation for Espressif Audio Development Framework (ADF)
5+
about: This is the documentation for Espressif Advanced Development Framework (ADF)
66
- name: ESP-IDF Programming Guide
77
url: https://docs.espressif.com/projects/esp-idf/en/latest/
88
about: Documentation for configuring and using ESP-IDF

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
1-
# Espressif Audio Development Framework
1+
# Espressif Advanced Development Framework
22

33
[![Documentation Status](./docs/_static/doc_latest.svg)](https://docs.espressif.com/projects/esp-adf/en/latest/?badge=latest)
44

5-
Espressif Systems Audio Development Framework (ESP-ADF) is the official audio development framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview), [ESP32-S2](https://www.espressif.com/en/products/socs/esp32-s2), [ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3), [ESP32-C6](https://www.espressif.com/en/products/socs/esp32-c6), [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3), and [ESP32-P4](https://www.espressif.com/en/products/socs/esp32-p4) SoCs.
5+
Espressif Systems Advanced Development Framework (ESP-ADF) is the official Advanced Development Framework for the [ESP32](https://espressif.com/en/products/hardware/esp32/overview), [ESP32-S2](https://www.espressif.com/en/products/socs/esp32-s2), [ESP32-C3](https://www.espressif.com/en/products/socs/esp32-c3), [ESP32-C6](https://www.espressif.com/en/products/socs/esp32-c6), [ESP32-S3](https://www.espressif.com/en/products/socs/esp32-s3), and [ESP32-P4](https://www.espressif.com/en/products/socs/esp32-p4) SoCs.
66

77
## Overview
88

docs/Doxyfile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
# https://www.stack.nl/~dimitri/doxygen/manual/config.html
1414

1515

16-
PROJECT_NAME = "Espressif Audio Development Framework (ESP-ADF)"
16+
PROJECT_NAME = "Espressif Advanced Development Framework Guide (ESP-ADF)"
1717

1818
## The 'INPUT' statement below is used as input by script 'gen-df-input.py'
1919
## to automatically generate API reference list files heder_file.inc

docs/en/about.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ The **ESP-ADF** provides a range of API components including **Audio Streams**,
99

1010
.. figure:: ../_static/adf_block_diagram.png
1111
:align: center
12-
:alt: Espressif Audio Development Framework
12+
:alt: Espressif Advanced Development Framework
1313
:figclass: align-center
1414

15-
Espressif Audio Development Framework
15+
Espressif Advanced Development Framework
1616

1717
The ESP-ADF also provides integration with **Baidu DauerOS** cloud services. A range of components is coming to provide integration with DeepBrain, Amazon, Google, Alibaba and Turing cloud services.
1818

19-
The **ESP-ADF** builds on well established, FreeRTOS based, Espressif IOT Development Framework `ESP-IDF <https://github.com/espressif/esp-idf>`_.
19+
The **ESP-ADF** builds on well established, FreeRTOS based, Espressif IOT Development Framework `ESP-IDF <https://github.com/espressif/esp-idf>`_.

docs/en/api-reference/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ API Reference
55
This API provides a way to develop audio applications using :doc:`Elements <framework/audio_element>` like :doc:`Codecs <codecs/index>` (Decoders and Encoders), :doc:`Streams <streams/index>` or :doc:`Audio Processing <audio-processing/index>` functions.
66

77
.. blockdiag::
8-
:caption: **Elements** of the Audio Development Framework
8+
:caption: **Elements** of the Advanced Development Framework
99
:align: center
1010

1111
blockdiag audio_elements {

docs/en/conf.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@
1616
current_year = datetime.datetime.now().year
1717

1818
# General information about the project.
19-
project = u'Audio Development Framework'
19+
project = u'Espressif Advanced Development Framework Guide'
2020
copyright = u'2017 - {}, Espressif Systems (Shanghai) Co., Ltd.'.format(current_year)
21-
pdf_title = u'Audio Development Framework Handbook'
21+
pdf_title = u'Espressif Advanced Development Framework Guide'
2222

2323
# The language for content autogenerated by Sphinx. Refer to documentation
2424
# for a list of supported languages.

0 commit comments

Comments
 (0)