## Summary Reshape the beginner-facing documentation so BacktestingKit reads as one guided learning journey instead of several overlapping entry points. ## Scope - simplify `README.md` into a lighter front door - make `docs/ONBOARDING.md` the canonical markdown tutorial - reduce overlap across `docs/GETTING_STARTED.md`, `docs/CHOOSE_YOUR_SURFACE.md`, and `docs/INDEX.md` - promote and align the existing DocC tutorial track - fix stale onboarding/tutorial examples and add lightweight success checkpoints ## Acceptance Criteria - one obvious markdown starting point - one obvious DocC/tutorial starting point - early-user docs have distinct roles - onboarding flow feels linear from build to app integration - stale `summary.result...` example usage is removed from the touched onboarding/tutorial surfaces - verification includes doc scans plus `swift build` and `swift test`
Activity
andywkff commentedon Apr 13, 2026
Completed the documentation/tutorial pass.
Highlights:
README.mdinto a lighter front door with a single proof-of-success snippet and clearer routingdocs/ONBOARDING.mdthe canonical markdown tutorialdocs/GETTING_STARTED.md,docs/CHOOSE_YOUR_SURFACE.md, anddocs/INDEX.mdsummary.result...snippets in the touched onboarding/tutorial docs and switched them tosummary.metrics...Verification:
rg -n 'summary\.result\.' README.md docs BacktestingKit/BacktestingKit.doccreturned no matchesswift buildswift testpassed with 122 tests and 0 failuresandywkff commentedon Apr 13, 2026
Final verification after the last markdown link cleanup:
rg -n 'summary\.result\.' README.md docs BacktestingKit/BacktestingKit.doccreturned no matchesswift testpassed again with 122 tests and 0 failuresNo code-path behavior changed in the final cleanup; the last pass was limited to doc link consistency inside
docs/.