dclause/hermes-five

Rationalize example naming and folder structure

开放

#23 创建于 2025年6月15日

 (0 条评论) (0 个反应) (0 位负责人)Rust (1 个派生)auto 404
code qualitydocumentationgood first issue

仓库指标

星标
 (37 个星标)
PR 合并指标
 (PR 指标待抓取)

描述

Motivation: Current example files and folder structure may be inconsistent or unclear, making it harder for users to discover and navigate them.

This task aims to review and improve:

  • Example file naming conventions
  • Folder organization within the examples/ directory

The goal is to improve usability and ease of discovery, especially for newcomers exploring features via examples.

Note:

  • Avoid naming example files after their corresponding src modules (e.g., led.rs, pca9685.rs) to improve file searchability in IDEs.
  • Update the example README file
  • Update the overall README file

Impact: No functional/API impact. This is a user / developer experience improvement.

贡献者指南