↓ Skip to main content
Developer Portal

Tagging content

4 mins·
Contribute
Author
Kirill Chalov
Senior technical writer at Espressif
Table of Contents

This article is split into the following parts:

  • Guidelines for assigning tags – gives you some background information
  • Assign tags – instructs you on how to and what tags to assign

Guidelines for assigning tags
#

In this section, you will find the following guidelines:

Once you familiarize yourself with these guidelines, go to Assign tags.

Choosing tags
#

  • Carefully choose tags and make sure they give a rough idea of who the article is for and what it is about. If the current tagging system does not cover important aspects, please share your feedback.
  • To avoid unnecessary specificity, prefer broader taxonomy terms, or omit tags entirely, when the content applies across multiple items in the same classification:
    • For content applicable to both Zephyr and NuttX, consider using the broader tag RTOS.
    • Do not add a specific SoC tag, such as ESP32, to content applicable to ESP32-C3 or other Espressif SoCs.
  • To avoid overly granular tagging, use only widely known hardware and software product names as tags. For lesser known hardware or software, use higher-level taxonomy terms instead:
    • ❌ (ESP32-C3-DevKit-RUST-1 → ✅ DevKit
    • ❌ Esp-Audio-Effects → ✅ ESP-IDF component
    • If a higher-level term is too broad and multiple articles fit a more specific tag, feel free to introduce such a tag (for example, use face recognition instead of the broader machine vision).

Spelling tags
#

  • Use lower case letters.
    Exceptions: Capitalize proper nouns and established terms, such as:
    • Product names: ESP32-P4, ESP-IDF, NuttX
    • Terms, protocols, and features: SoC, Ethernet, WebRTC
    • Abbreviations: IDE, LED, LLVM
  • Use tags in singular.
    Exceptions: Singular (uncountable) words that end in s:
    • Mass nouns: graphics, robotics
    • Established terms: ESP Insights, DevOps
  • Use spaces to separate words.
    Exceptions: Use hyphens only in established terms:
    • Compound terms: ESP32-C3, esp-idf-kconfig, Wi-Fi

Assign tags
#

Take the following steps:

  1. Choose appropriate tags as explained in Tagging process.
  2. In your article’s YAML frontmatter, add these tags as follows:
    tags:
  - tag1
  - tag2
  - ...

Tagging process
#

Navigate to mandatory and lower-priority tag category subsections listed below and choose four to six tags in total that best describe your content. Please note that the actual tags are marked in monospace, the rest is taxonomy words and comments to assist in choosing tags.

Mandatory categories:

Lower-priority categories:

Hardware type / Software framework / OS / IDE
#

  • hardware type
    • SoC
    • module
    • DevKit – use for Espressif boards
    • development board – use for 3rd party boards
    • M5Stack
    • BSP
  • software framework
    • ESP-IDF
    • ESP RainMaker
    • ESP-ADF
    • Arduino
  • OS
    • bare metal
    • Linux (POSIX?)
    • Windows
    • RTOS
      • FreeRTOS
      • NuttX
      • Zephyr
  • IDE
    • Espressif-IDE
    • ESP-IDF Extension for VS Code

Complexity
#

  • beginner – assumes no prior domain knowledge
  • practitioner – assumes familiarity with core concepts
  • expert – assumes strong domain knowledge

Content type
#

If content is a mixture of overview and how-to / tutorial, how-to and tutorial tags take precedence.

  • new product (NPI)
  • announcement (news, newsletter)
  • release (software releases)
  • overview
  • how-to
  • tutorial
  • workshop
  • roadmap
  • benchmarks / performance
  • product development
  • DIY project

Community involvement
#

  • community software – overview of community software for Espressif products
  • community hardware – overview of community hardware based on Espressif products
  • community contribution – contribution from outside Espressif
  • community event – announcement or overview of a community event

Additional hardware information
#

  • Hardware peripheral
    • display: LCD, MIPI-CSI
    • communication bus: I2C, SPI, USB, Ethernet, CAN
    • debug interface: JTAG, UART
    • ADC
    • camera
    • LED
    • motor
    • IMU
    • PIE
  • Hardware concept
    • CPU architecture: RISC-V, Xtensa
    • driver
    • memory (PSRAM, flash)
    • low power (power efficiency, low power core, deep sleep)
    • memory management
    • bootloader
    • MCUboot

Additional software information
#

  • Programming language
    • Assembly
    • Python
    • MicroPython
    • Lua
    • Rust
    • Swift
    • C
    • C++
  • ESP-IDF tool or part
    • build system
    • ESP-IDF component
    • ESP-IDF tool
    • idf.py
    • esp-idf-kconfig
    • EIM
    • esptool
    • sdkconfig
  • Communication protocol (Wireless)
    • Wi-Fi (Wi-Fi 6?)
    • Bluetooth
    • BLE
    • BLE Mesh
    • MQTT
    • Matter
    • Thread
    • ESP-NOW
    • Zigbee
    • WebRTC
  • Compiling
    • GCC
    • CMake
    • LLVM
    • partition table
    • cross-compilation
  • Software concepts
    • simulation
      • QEMU
      • Wokwi
    • graphics
    • GUI
      • Qt
      • lvgl
    • HTTP server
    • porting
    • library – use for 3rd party libraries
    • zero-code
    • low-code
    • CLI
    • debugging
    • multimedia processing (multimedia)
      • video processing (H.264, H.265, motion detection)
      • image processing (JPEG)
      • audio processing (speech recognition, voice assistant)

Security
#

  • Secure Boot
  • Flash Encryption
  • ESP-TEE
  • NVS encryption
  • ESP Privilege Separation

Application domains
#

  • IoT
  • smart home
  • industrial automation
  • wearables
  • smart agriculture
  • programming
  • robotics
  • machine vision
  • audio

Industry keywords
#

  • HMI
  • deep learning
  • AI
  • LLM
  • MCP
  • edge computing (neural networks)
  • AIoT

Third-party products and titles
#

  • OpenOCD
  • ChatGPT
  • GitHub CoPilot
  • KiCad
  • CLion
  • Jupyter Notebooks (Jupyter)
  • WLED
  • Eclipse
  • VS Code
  • Alexa
  • Home Assistant

Other
#

  • infrastructure
    • CI/CD
    • embedded DevOps
    • API
    • Cloud
    • phone app
    • OTA
  • Artifact
    • book
    • example code
    • reference design
  • Event
    • DevCon
  • Documentation
    • datasheet
    • TRM
    • ESP Insights

Related