Skip to content

Docs overhaul: beginner-first README, three-engine consistency, real->f64#22

Merged
NiceAndPeter merged 1 commit into
mainfrom
docs-update
Jul 19, 2026
Merged

Docs overhaul: beginner-first README, three-engine consistency, real->f64#22
NiceAndPeter merged 1 commit into
mainfrom
docs-update

Conversation

@NiceAndPeter

Copy link
Copy Markdown
Owner

Summary

  • README rewritten beginner-first (224 → 99 lines): "what is bound for" bullets up top, prominent tutorial link, grouped docs index; single-header + regeneration content moved to new docs/single-header.md, C++20 build mode to docs/freestanding.md
  • Docs pass over all 13 hand-written docs: three-engine (dbl/flt/cordic) story fixed in math.md/determinism.md/resources.md/tutorial.md/internals.md; freestanding.md + roadmap.md now reflect shipped BND_MATH_NO_FP; deprecated real spelling migrated to f64/f32; broken links/anchors fixed; diagnostics.md bit table completed against policy_flag.hpp
  • Generated docs (accuracy.md, performance.md) untouched

Verification

  • All relative links and cross-doc anchors resolve
  • README/tutorial snippets compile with g++ -std=c++23 -fsyntax-only -I include
  • grep clean: no stale "two engines" claims, no primary-real spellings outside deprecation asides

🤖 Generated with Claude Code

@NiceAndPeter
NiceAndPeter merged commit c1c5519 into main Jul 19, 2026
21 checks passed
@NiceAndPeter
NiceAndPeter deleted the docs-update branch July 19, 2026 18:10
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