Skip to content

help: Fix broken and missing figure references in equation library - #1715

Open
Wiljea wants to merge 1 commit into
c3d:stablefrom
Wiljea:fix-equation-figures
Open

help: Fix broken and missing figure references in equation library#1715
Wiljea wants to merge 1 commit into
c3d:stablefrom
Wiljea:fix-equation-figures

Conversation

@Wiljea

@Wiljea Wiljea commented Aug 7, 2026

Copy link
Copy Markdown

Many equation-library figures were not shown on the device because their references in doc/calc-help/equations.md did not match any BMP in doc/img (the build only copies doc/img/*.bmp to the on-device help/img). Causes: images committed only as PNG (never reaching the device), references using spaces / non-breaking spaces / wrong suffixes, misspelled image filenames, and one placeholder reference.

  • Add 7 physics figures as BMP (Hall Effect, Cyclotron, Helicoidal Motion, Fiber Optic, Rayleigh's Criterion, Malus Law, Driven Damped Oscillations) and drop the stale PNG/orphan copies that never reached the device.
  • Correct 15 references in equations.md to existing BMP names (e.g. Series&Parallel -> SeriesAndParallel, Mohr's -> MohrsCircle, Projectile_BW -> ProjectileMotion, "Missing name" -> HookesLaw).
  • Rename 3 misspelled image files (Bernouilli -> Bernoulli, 1DElasti -> 1DElastic, FlowWIth -> Flowwith).
  • Remove the reference to the non-existent DC Inductor Voltage figure.
  • Regenerate help/db48x.md and update help/db50x.md accordingly.

Result: 0 broken figure references in the equation library.

@c3d
c3d force-pushed the dev branch 2 times, most recently from 1ba2834 to d3925c0 Compare August 25, 2026 23:33
@c3d c3d added documentation Improvements or additions to documentation user Reported by an actual user, yay! done Issues that are done on dev (will be in next release) labels Aug 25, 2026
Many equation-library figures were not shown on the device because their
references in doc/calc-help/equations.md did not match any BMP in doc/img
(the build only copies doc/img/*.bmp to the on-device help/img). Causes:
images committed only as PNG (never reaching the device), references using
spaces / non-breaking spaces / wrong suffixes, misspelled image filenames,
and one placeholder reference.

- Add 7 physics figures as BMP (Hall Effect, Cyclotron, Helicoidal Motion,
  Fiber Optic, Rayleigh's Criterion, Malus Law, Driven Damped Oscillations)
  and drop the stale PNG/orphan copies that never reached the device.
- Correct 15 references in equations.md to existing BMP names (e.g.
  Series&Parallel -> SeriesAndParallel, Mohr's -> MohrsCircle,
  Projectile_BW -> ProjectileMotion, "Missing name" -> HookesLaw).
- Rename 3 misspelled image files (Bernouilli -> Bernoulli,
  1DElasti -> 1DElastic, FlowWIth -> Flowwith).
- Remove the reference to the non-existent DC Inductor Voltage figure.
- Regenerate help/db48x.md and update help/db50x.md accordingly.

Result: 0 broken figure references in the equation library.

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
(cherry picked from commit aea296f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation done Issues that are done on dev (will be in next release) user Reported by an actual user, yay!

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants