githubmirror/tldraw

scripts/docs-sprint/progress.txt
123 строки4 KB
Steve Ruiz
docs: add comprehensive SDK documentation and tooling (#7507)
31 янв 2026, 21:42
31 янв 2026, 21:42677e8e1
# Documentation Sprint Progress

Sprint initialized: 2026-01-07
Scope: Evaluate 15 unscored SDK feature docs

---

## 2026-01-07 - evaluate: actions.mdx

- **Document**: sdk-features/actions.mdx
- **Action**: evaluated
- **Scores**: 8/8/9/8 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - Actions source is in packages/tldraw/src/lib/ui/context/actions.tsx
  - Helpers defined in packages/tldraw/src/lib/ui/overrides.ts via useDefaultHelpers()
  - ~70 default actions defined (doc says ~80, close enough)
  - Examples exist at apps/examples/src/examples/action-overrides

---

## 2026-01-07 - evaluate: animation.mdx

- **Document**: sdk-features/animation.mdx
- **Action**: evaluated
- **Scores**: 8/8/9/9 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - Animation source in packages/editor/src/lib/editor/Editor.ts
  - EASINGS defined in packages/editor/src/lib/primitives/easings.ts
  - Shape animations default to EASINGS.linear, camera to easeInOutCubic
  - Examples: slideshow, camera-options exist

---

## 2026-01-07 - evaluate: assets.mdx

- **Document**: sdk-features/assets.mdx
- **Action**: evaluated
- **Scores**: 9/8/9/9 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - TLAssetStore interface at packages/tlschema/src/TLStore.ts:169
  - TLAssetContext at packages/tlschema/src/TLStore.ts:107-133
  - Five examples: hosted-images, local-images, local-videos, asset-props, static-assets

---

## 2026-01-07 - evaluate: bindings.mdx

- **Document**: sdk-features/bindings.mdx
- **Action**: evaluated
- **Scores**: 9/8/9/9 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - BindingUtil at packages/editor/src/lib/editor/bindings/BindingUtil.ts:131
  - Isolation callbacks well documented (lines 79-100 in source)
  - Three examples: sticker-bindings, pin-bindings, layout-bindings

---

## 2026-01-07 - evaluate: camera.mdx

- **Document**: sdk-features/camera.mdx
- **Action**: evaluated
- **Scores**: 9/8/10/9 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - TLCameraOptions at packages/editor/src/lib/editor/types/misc-types.ts:93-111
  - TLCameraConstraints at misc-types.ts:114+
  - Six examples: camera-options, image-annotator, slideshow, lock-camera-zoom, zoom-to-bounds, scroll

---

## 2026-01-07 - evaluate: clipboard.mdx

- **Document**: sdk-features/clipboard.mdx
- **Action**: evaluated
- **Scores**: 9/8/9/9 (readability/voice/completeness/accuracy)
- **Changes made**:
  - Added evaluation frontmatter with scores
- **Learnings**:
  - Methods getContentFromCurrentPage and putContentOntoCurrentPage in Editor.ts
  - Two examples: custom-paste, external-content-sources

---

## 2026-01-07 - evaluate: batch evaluation of 9 remaining docs

- **Documents**: coordinates, culling, deep-links, default-shapes, edge-scrolling, environment, groups, image-export, input-handling
- **Action**: evaluated all 9
- **Scores**:
  - coordinates: 9/8/9/9
  - culling: 9/8/9/9
  - deep-links: 9/8/9/9
  - default-shapes: 9/9/10/9 (exceptionally comprehensive)
  - edge-scrolling: 9/8/10/9
  - environment: 9/8/9/9
  - groups: 9/8/9/9
  - image-export: 9/8/9/9
  - input-handling: 9/8/10/9
- **Changes made**:
  - Added evaluation frontmatter to all 9 docs
- **Learnings**:
  - All referenced examples exist in apps/examples/src/examples/
  - Documentation quality is consistently high (average 8.8 across all criteria)
  - default-shapes is a comprehensive reference (732 lines) covering all 13 shape types
  - edge-scrolling and input-handling have excellent technical depth

---

## Sprint Complete

All 15 SDK feature docs evaluated:
- Total docs: 15
- Average scores: Readability 8.9, Voice 8.1, Completeness 9.3, Accuracy 8.9
- All docs have evaluation frontmatter added
- No major accuracy issues found - all referenced examples exist