dclause/hermes-five

Rationalize example naming and folder structure

オープン

#23 opened on 2025/06/15

 (0 件のコメント) (0 件のリアクション) (0 人の担当者)Rust (1 件のフォーク)auto 404
code qualitydocumentationgood first issue

Repository metrics

Stars
 (37 個のスター)
PR merge metrics
 (PR metrics pending)

説明

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.

コントリビューターガイド