Skip to content

Commit 3123048

Browse files
authored
Merge pull request #514 from espressif/blog/add_cdp_introduction
Sync Merge: blog/add_cdp_introduction
2 parents 7f31540 + a5b6f2c commit 3123048

File tree

5 files changed

+147
-0
lines changed

5 files changed

+147
-0
lines changed
52.4 KB
Loading
62.8 KB
Loading
82.1 KB
Loading
55.6 KB
Loading
Lines changed: 147 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,147 @@
1+
---
2+
title: "Introducing CDP: The New Espressif Documentation Website – Now in Customer Preview!"
3+
date: 2025-07-07
4+
showAuthor: false
5+
featureAsset: "img/featured/featured-announcement.webp"
6+
summary: This article introduces Espressif’s new Centralized Documentation Platform (CDP) — a unified site for all technical documentation, featuring enhanced search, integrated chatbot support, and improved feedback tools.
7+
---
8+
9+
We’re excited to announce that our brand-new documentation website, the [Centralized Documentation Platform](https://documentation.espressif.com/en/home) (**CDP**), is now open for **Customer Preview**!
10+
11+
CDP has been built with users in mind. It aims to bring together everything you need to find, read, and interact with Espressif’s technical documentation — in one centralized, easy-to-use place.
12+
13+
## 📚 What is CDP?
14+
15+
**CDP** stands for **Espressif Centralized Documentation Platform**, and it’s your new one-stop hub for exploring **all of Espressif’s technical documents**.
16+
17+
With CDP, you can:
18+
19+
- 🔍 **Search** through a unified library of Espressif documents
20+
- 📑 **Browse** documents by a hardware or software product or a document type
21+
- 💬 **Chat** with documents using our AI-powered chatbot
22+
23+
{{< alert iconColor="#df8e1d" cardColor="#edcea3">}}
24+
**CDP focuses on documentation**. It does not replace the product pages on www.espressif.com.
25+
{{< /alert >}}
26+
27+
## 🤔 Why CDP?
28+
29+
You might be wondering — why a whole new site?
30+
31+
Currently, Espressif documents are **scattered across multiple platforms**, including:
32+
33+
- www.espressif.com – hosting [Technical Documents](https://www.espressif.com/en/support/documents/technical-documents), [PCNs](https://www.espressif.com/en/support/documents/pcns), [Advisories](https://www.espressif.com/en/support/documents/advisories), and [Certificates](https://www.espressif.com/en/support/documents/certificates)
34+
35+
- docs.espressif.com – hosting primarily software documents
36+
- Various **GitHub repositories**
37+
38+
**CDP** aims to bring them together into one single place.
39+
40+
## ✨ Key Features of CDP
41+
42+
Here’s what you can experience during this preview.
43+
44+
### Espressif’s Technical Documentation in One Place
45+
46+
CDP aims to bring all Espressif’s technical documentation into one centralized place and has made a significant step towards that goal.
47+
48+
Compared with the old [technical document webpage](https://www.espressif.com/en/support/documents/technical-documents) on [www.espressif.com](https://www.espressif.com), CDP offers many more documents (including English and Chinese versions):
49+
50+
- ~ 800 certificates
51+
- ~ 100 PCNs
52+
- ~ 100 advisories
53+
- ~ 200 software documents
54+
55+
Most of the above-mentioned documents are available in **HTML** format, including those only available in PDF format traditionally:
56+
57+
- Datasheets
58+
- Technical reference manuals (TRMs)
59+
- PCNs and advisories
60+
61+
{{< figure
62+
default=true
63+
src="esp32-c6-datasheet-in-html.webp"
64+
caption="[ESP32-C6 Datasheet in HTML](esp32-c6-datasheet-in-html.webp)"
65+
>}}
66+
67+
### ChatBot
68+
69+
Need quick answers? Our AI-powered chatbot is here to help!
70+
71+
- You can ask questions in **any language**
72+
- The bot responds **based on Espressif documentation only**
73+
- If the requested information is not available in the documentation, the chatbot will respectfully indicate this to avoid providing inaccurate or speculative responses (hallucinations)
74+
- Each answer includes **references to the source documents**, so you can verify the information
75+
76+
{{< figure
77+
default=true
78+
src="chatbot-on-cdp.webp"
79+
caption="[Chatbot on CDP](chatbot-on-cdp.webp)"
80+
>}}
81+
82+
### Enhanced Search
83+
84+
The new search function is designed to help you quickly locate exactly what you need.
85+
86+
- Search **across all documents** or limit the search to the **currently opened document**
87+
- Use **fuzzy search** by default for more flexible matching
88+
- Support **exact match** searches when you check the “Exact Match” option
89+
- Combine search with **filters** for greater precision
90+
- **Automatically correct typos** in your keywords to save time on small mistakes
91+
92+
{{< figure
93+
default=true
94+
src="exact-search-in-document-center.webp"
95+
caption="[Exact Search in Document Center](exact-search-in-document-center.webp)"
96+
>}}
97+
98+
### Comprehensive Filters
99+
100+
Quickly locate the information you need using a powerful and flexible filtering system.
101+
102+
- Filter by **PRODUCT SERIES** to find documents for a particular chip series
103+
- Use **CATEGORIES** to narrow down to specific software or hardware groups
104+
- Toggle **Show EOL Products** to view documents for end-of-life products
105+
- Select by **DOCUMENT TYPE** (e.g., datasheet, manual, certificate, PCN, etc.) to find exactly what you need
106+
107+
### Collection of User Feedback
108+
109+
Your input matters! CDP includes a built-in feedback mechanism to:
110+
111+
- Let you report errors, make suggestions, or leave comments
112+
- Help the Espressif Technical Documentation Team understand what’s working — and where we can do better
113+
- Shape the future of CDP through continuous, community-driven improvements
114+
115+
{{< figure
116+
default=true
117+
src="feedback-submission.webp"
118+
caption="[Feedback Submission](feedback-submission.webp)"
119+
>}}
120+
121+
## 🔮 What’s Next?
122+
123+
We have some more features coming! Here’s what’s coming next:
124+
125+
- Subscription to documents
126+
- A more polished experience of **homepage, filters, etc**.
127+
- Continued improvements based on your **feedback**
128+
- **Redirecting and retiring older pages**:
129+
130+
- Pages for [Technical Documents](https://www.espressif.com/en/support/documents/technical-documents), [PCNs](https://www.espressif.com/en/support/documents/pcns), [Advisories](https://www.espressif.com/en/support/documents/advisories), and [Certificates](https://www.espressif.com/en/support/documents/certificates) on [www.espressif.com](https://www.espressif.com) will be closed by the end of 2025, assuming no major issues are found. After that point, traffic to those pages will be **automatically redirected to CDP**.
131+
- For now, content on platforms like docs.espressif.com and GitHub will **continue to be updated in parallel** with CDP. No shutdown date is currently set for those platforms.
132+
133+
## 💬 We Need Your Feedback!
134+
135+
This is a **preview**, and CDP is still a work in progress. We’d love your help to make CDP better. Whether you find a bug, have a suggestion, or just want to tell us what you think — we’re all ears.
136+
137+
**Just click the Feedback button on the right of each page on CDP!**
138+
139+
Thanks for being part of the Espressif community. We’re excited to bring you a better documentation experience and can’t wait to hear what you think of **CDP**!
140+
141+
## Conclusion
142+
143+
The Centralized Documentation Platform (CDP) marks a significant step toward a better, more streamlined way to access Espressif’s technical resources. With smarter search, AI-powered assistance, and an intuitive interface, CDP is designed to make your documentation experience faster, easier, and more productive.
144+
145+
We invite you to explore the platform, try out the new features, and let us know how it works for you. Your feedback is crucial in helping us refine and grow CDP into the best possible tool for the Espressif developer community.
146+
147+
Happy exploring!

0 commit comments

Comments
 (0)