summaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2026-05-24docs: de-LLM all .md files - remove corporate language, over-explanation, ↵Paul Buetow
and LLM patterns
2026-05-24docs: add CLI usage guide (task di)Paul Buetow
Document all invocation modes (single-expression, REPL, pipe, stdin), boolean coercion rules, version/help behavior, exit codes, and practical use cases for scripts and CI pipelines.
2026-05-24docs: add symbols.md — document :x syntax and symbol behavior (task ci)Paul Buetow
2026-05-24docs: add repl-mode.md documentation (task bi)Paul Buetow
2026-05-24docs: add rational-mode.md documentation (task ai)Paul Buetow
Test and document rational number mode: - rat on/off/toggle commands (REPL only) - How big.Rat integration works internally - Precision comparison examples with actual output - Known limitation: +, -, % fail for non-dyadic decimals (0.1, 0.2) due to Rat.Float64() rejecting lossy conversions - Performance trade-offs vs float64 mode - Edge cases including metrics, constants, and variables - When to use rational mode and when to stick with float mode
2026-05-24docs: add custom-metrics.md (task 9i)Paul Buetow
Document custom metric commands (define/undefine/list/show) with syntax, REPL workflow examples, arithmetic usage, practical use cases, and edge cases including duplicate names, invalid categories, and factor zero behavior.
2026-05-24docs: add metric-commands.md (task 8i)Paul Buetow
Document all metric subcommands with real CLI output examples: - metric show: inspect metric info for top of stack - metric list: list all metric categories - metric <category>: list units in a category - metric compatible: check compatibility of two values - metric decimal set / metric binary set: SI vs IEC modes Covers REPL vs single-command differences, SI vs IEC prefix modes, and practical use cases for exploring and verifying metrics.
2026-05-24docs: add unit-conversion.md (task 7i)Paul Buetow
Document the @prefix convert syntax with real examples for all metric categories (DataRate, DataSize, Time, Weight, Speed, Distance, Universal). Includes practical use cases for bandwidth planning, travel, cooking, and data storage, plus edge case coverage for incompatible categories, unknown metrics, Cool absorbing, and SI/IEC interoperability.
2026-05-24docs: add metrics.md — metrics system referencePaul Buetow
Complete documentation of all 7 metric categories with units, suffix notation, unit conversion, metric-aware arithmetic rules, cross-category inference, SI/IEC prefix modes, custom metrics, and practical use cases (bandwidth, travel, weight).
2026-05-24docs: add constants.md — built-in constants referencePaul Buetow
Complete documentation of all 36 built-in mathematical constants: fundamental (pi, e, phi, tau), square roots, logarithms, reciprocals, special values (inf, nan), usage examples, practical use cases (geometry, engineering, information theory), and edge cases.
2026-05-24docs: add variables.md; tests: comprehensive assignment operator testsPaul Buetow
- Document all assignment operators (:=, =:, =) with syntax table - Document variable management commands (vars, clear, d) - Document variable lifecycle and practical use cases - Add table-driven tests for := and =: operators - Add tests for = with expression continuation - Add tests for variable reuse in expressions - Add tests for chained assignments - Add tests for vars/clear commands - Add tests for d (delete) operator - Add tests for variable persistence across expressions
2026-05-24docs: add stack operations documentationPaul Buetow
Document dup, swap, pop, show/showstack/print, and clear with: - Stack visualizations for each operation - CLI examples with expected output - Practical use cases (self-comparison, reordering, debugging) - Error handling behavior - Combined examples showing multi-operator workflows
2026-05-24docs: add log operators documentation (lg, log, ln)Paul Buetow
Cover lg (log base 2), log (log base 10), and ln (natural log) with: - Mathematical explanations - RPN examples from live testing - Edge cases (zero and negative number errors) - Practical use cases (information theory, decibels, pH, growth) - Metric handling notes - Implementation references
2026-05-24docs: add hyper operators documentationPaul Buetow
Cover all nine hyper operators ([+], [*], [-], [/], [^], [%], [lg], [log], [ln]) with examples, metric behavior, practical use cases, and edge cases.
2026-05-24docs: add comparison operators documentationPaul Buetow
Cover all 6 comparison operators (gt/>/lt</gte>=/lte<=/eq==/neq!=), truth tables, metric-aware comparisons, boolean coercion in arithmetic, and practical use cases (threshold checks, range validation, guards).
2026-05-24docs: add fast-power.md documenting ** operatorPaul Buetow
Cover binary exponentiation algorithm, syntax, examples, ** vs ^ comparison, edge cases, and performance notes.
2026-05-24docs: add basic arithmetic RPN operators referencePaul Buetow
Document all six basic arithmetic operators (+, -, *, /, ^, %) with: - RPN explanation and stack visualization - Each operator with examples and results - Multi-operand and nested expression examples - Practical use cases (geometry, compound calculations) - Edge cases (division/modulo by zero, negative results)
2026-05-24docs: add percentage calculations guidePaul Buetow
Test all three percentage forms (X% of Y, X is what% of Y, X is Y% of what) and document syntax, examples, practical use cases, edge cases, output format, and known limitations.