Skip to content

docs: standardise README and add docs/ - #187

Merged
willtheorangeguy merged 1 commit into
mainfrom
docs/content
Aug 22, 2026
Merged

willtheorangeguy merged 1 commit into
mainfrom
docs/content

Conversation

@willtheorangeguy

Copy link
Copy Markdown
Owner

@
Brings Running-Calculator in line with the Wave 2 documentation contract.

README — rewritten to the house template. The credits table is unchanged.

docs/ — README.md (index), quickstart.md, installation.md, units.md (renamed from UNITS.md), architecture.md, development.md, faq.md, troubleshooting.md, roadmap.md, and internal/known-issues.md. Removed docs/USAGE.md (folded into quickstart) and the unused docs/images/.

Findings — three, recorded in docs/internal/known-issues.md and not fixed:

  • A total time of zero divides by zero and exits with a traceback (Medium). Verified by running it; the prompts invite the input that causes it.
  • Three of the six conversions in the in-program unit list are wrong (Medium). The constants are correct, so results are unaffected — only the printed reference has drifted.
  • The in-program licence notice says 2022-2023 while the file header says 2022-2026 (Low).
    @

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01TtaJBmFDK3GcSyuhSuZ84R
@willtheorangeguy
willtheorangeguy merged commit 2a881a0 into main Aug 22, 2026
12 checks passed
@willtheorangeguy
willtheorangeguy deleted the docs/content branch August 22, 2026 05:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant