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.

貢獻者指南