Skip to content

Complete documentation and tutorial pass #2

@andywkff

Description

@andywkff

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

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type
No fields configured for issues without a type.

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions