Documentation: make performance and platform claims independently verifiable
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Tech stack
- c, github-actions
- Domain
- documentation
Research direction
Start with the README performance and platform claims, then inspect the benchmark workflow run 42153892833 and its webserver-result artifact, docs/embedded/stm32.md, and the STM32F769I-DISCO fortress example. Trace each claim to current CI results or documented physical-board procedures, distinguishing those from QEMU and cross-build checks. Done when the README claims link to evidence and describe benchmark conditions and feature maturity.
Written by the indexing model from the issue text.
Description
The README makes broad performance and platform claims that can look implausible without direct links to evidence. This is a documentation credibility issue, not evidence that the project is fictional: the implementation, regression suite, CI benchmark artifacts, embedded examples, and physical STM32 validation exist.
A legitimate concern is that a hardcoded benchmark table remained stale even while newer CI results were available. Broad claims also need clearer separation between hosted features, experimental features, cross-build checks, QEMU, and physical-board validation.
Proposed improvements:
- Link benchmark summaries to the exact workflow run, commit, and downloadable result artifact, and keep generated values ahead of hand-maintained prose.
- Link embedded claims to board-specific build, flash, and runtime validation instructions, clearly distinguishing physical hardware from QEMU and cross-compilation.
- Document benchmark hardware, workload, limitations, and reproduction steps next to every headline performance claim.
- Mark experimental or partial platform features explicitly instead of presenting every feature as equally mature.
- Avoid production or scale claims unless they link to a reproducible public artifact.
Example evidence available now: the 2026-11-06 benchmark run 42153892833 and its webserver-result artifact, the STM32F769I-DISCO fortress example, and docs/embedded/stm32.md.
Acceptance criteria: performance and embedded claims in the README can be independently traced to current CI artifacts or documented physical-board procedures without relying on unsupported superlatives.
- Dominant language
- C
- Stars
- 16
- Forks
- 7
- Avg merge
- 4h 28m
- Merged PRs (30d)
- 191
Getting set up
- No Dockerfile or Docker Compose file
- No pull request template
- Read the contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from c4punks/CWIST
-
enhancement good first issue
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 4/5 3-5 days Newbie friendliness 52/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 57/100
Maintainers usually reply within 1 day
-
enhancement
Difficulty 4/5 3-5 days Newbie friendliness 48/100
Maintainers usually reply within 1 day
-
enhancement good first issue
Difficulty 5/5 Over a week Newbie friendliness 35/100
Maintainers usually reply within 1 day
Similar issues
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 75/100
micropython/micropython#19906 ·
Maintainers usually reply within 1 day
-
Difficulty 1/5 Under an hour Newbie friendliness 75/100
Maintainers usually reply within 10 days
-
bug
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 83/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
sk3llo/ffmpeg_kit_flutter#176 ·