dclause / dclause/hermes-five

Rationalize example naming and folder structure

Open
#23 0 comments 0 reactions 0 assignees View on GitHub
code quality documentation good first issue
Dominant language
Rust
Stars
38
Forks
1
PR merge metrics
No merged PRs in 30d

Description

**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.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.