kayg/calternal

Watch

Fork 0

Docs build: document new packages/ui and packages/editor exports (ratchet 229 vs 211) #1155

New issue

Open

opened 2026-10-05 15:28:16 +00:00 by kayg · 3 comments

kayg commented

2026-10-05 15:28:16 +00:00

Owner

Blocking the docs deploy (#1143)

bun run --cwd apps/docs build fails on dev: the TypeScript doc-comment ratchet is 229 vs baseline 211 (apps/docs/doc-coverage.json). New exports without doc comments:

packages/ui: CalendarActionItem, CalendarItemAction*, CopyableValue, InlineRename, InspectorRow, InspectorSection, ItemCard, ItemChip, ModeIcon, RequestState, TextInput, TimeZoneChip, VoicePill*, VoicePlayback, VoicePlayToggle, VoiceRecordingPill, inlineAudioPlayback*
packages/editor: ImagePasteContent, NoteCardsLayer

Do: add accurate TSDoc comments (ASD-STE100 Simplified Technical English: what it is, when to use it, important props/invariants) to every listed export, reading each component to describe real behaviour. Do NOT raise the baseline; the count must return to ≤ 211. Do not edit apps/docs or apps/website (owned by the Mac thread); run their build only to verify: bun run --cwd apps/docs build and quote the coverage line verbatim. Also run bun run check in packages/ui and packages/editor if present. Comment on #1143 with the commit SHA once on your branch. Do not push.

## Blocking the docs deploy (#1143) `bun run --cwd apps/docs build` fails on dev: the TypeScript doc-comment ratchet is 229 vs baseline 211 (apps/docs/doc-coverage.json). New exports without doc comments: - packages/ui: CalendarActionItem, CalendarItemAction*, CopyableValue, InlineRename, InspectorRow, InspectorSection, ItemCard, ItemChip, ModeIcon, RequestState, TextInput, TimeZoneChip, VoicePill*, VoicePlayback, VoicePlayToggle, VoiceRecordingPill, inlineAudioPlayback* - packages/editor: ImagePasteContent, NoteCardsLayer Do: add accurate TSDoc comments (ASD-STE100 Simplified Technical English: what it is, when to use it, important props/invariants) to every listed export, reading each component to describe real behaviour. Do NOT raise the baseline; the count must return to ≤ 211. Do not edit apps/docs or apps/website (owned by the Mac thread); run their build only to verify: `bun run --cwd apps/docs build` and quote the coverage line verbatim. Also run `bun run check` in packages/ui and packages/editor if present. Comment on #1143 with the commit SHA once on your branch. Do not push.

kayg referenced this issue

2026-10-05 15:28:34 +00:00

Host docs.calternal.com on Cloudflare Pages; add export guides #1143

kayg commented

2026-10-05 17:42:38 +00:00

Author

Owner

Starting #1155 on branch job/docratchet-1155, based at de654a42ac4f9a6dca83bed8e0eebc99706f7dfe. The worktree reports 48 commits behind its current origin/dev tracking ref; I will merge origin/dev once before final gates. I will add TSDoc only in the listed packages, then run their checks and the docs build without editing docs or website files.

Starting #1155 on branch `job/docratchet-1155`, based at `de654a42ac4f9a6dca83bed8e0eebc99706f7dfe`. The worktree reports 48 commits behind its current `origin/dev` tracking ref; I will merge `origin/dev` once before final gates. I will add TSDoc only in the listed packages, then run their checks and the docs build without editing docs or website files.

kayg commented

2026-10-05 18:05:01 +00:00

Author

Owner

Completed #1155 on branch job/docratchet-1155.

Built: Added TSDoc for the requested packages/ui component exports and Calendar/audio contracts, plus packages/editor's ImagePasteContent and NoteCardsLayer. The docs baseline is unchanged. The focused coverage list contains no remaining missing entries for the requested symbols.

Files:

packages/ui/src/index.ts
packages/ui/src/components/calendar/model.ts
packages/ui/src/components/calendar/inlineAudioPlayback.svelte.ts
packages/ui/src/components/VoicePill.svelte
packages/editor/src/attachmentPaste.ts
packages/editor/src/index.ts

Head SHA: 5f78727497fc7cc8d1708cab6ff13cbbc1eef971

Gate output:

20:00:58 [calternal-reference] TypeScript: 206 undocumented (baseline 211). Lower the baseline with \bun run --cwd apps/docs coverage --update`.`

svelte-check found 0 errors and 0 warnings

git diff --check passed with no output. packages/ui has no check script. cargo clean completed: Removed 1 file, 356B total.

Known gaps: No UI behavior changed. packages/ui has no package-level check script.

Decisions: Component comments sit on public re-exports; type and state comments sit beside their declarations. No product decision was needed. The docs coverage baseline was not changed.

Completed #1155 on branch `job/docratchet-1155`. **Built:** Added TSDoc for the requested `packages/ui` component exports and Calendar/audio contracts, plus `packages/editor`'s `ImagePasteContent` and `NoteCardsLayer`. The docs baseline is unchanged. The focused coverage list contains no remaining missing entries for the requested symbols. **Files:** - `packages/ui/src/index.ts` - `packages/ui/src/components/calendar/model.ts` - `packages/ui/src/components/calendar/inlineAudioPlayback.svelte.ts` - `packages/ui/src/components/VoicePill.svelte` - `packages/editor/src/attachmentPaste.ts` - `packages/editor/src/index.ts` **Head SHA:** `5f78727497fc7cc8d1708cab6ff13cbbc1eef971` **Gate output:** `20:00:58 [calternal-reference] TypeScript: 206 undocumented (baseline 211). Lower the baseline with \`bun run --cwd apps/docs coverage --update\`.` ` svelte-check found 0 errors and 0 warnings` `git diff --check` passed with no output. `packages/ui` has no `check` script. `cargo clean` completed: `Removed 1 file, 356B total`. **Known gaps:** No UI behavior changed. `packages/ui` has no package-level check script. **Decisions:** Component comments sit on public re-exports; type and state comments sit beside their declarations. No product decision was needed. The docs coverage baseline was not changed.

kayg commented

2026-10-05 18:05:22 +00:00

Author

Owner

Formatting correction to the gate output in my completion report. Exact output from the final checks:

20:00:58 [calternal-reference] TypeScript: 206 undocumented (baseline 211). Lower the baseline with `bun run --cwd apps/docs coverage --update`.

svelte-check found 0 errors and 0 warnings

Formatting correction to the gate output in my completion report. Exact output from the final checks: ``` 20:00:58 [calternal-reference] TypeScript: 206 undocumented (baseline 211). Lower the baseline with `bun run --cwd apps/docs coverage --update`. svelte-check found 0 errors and 0 warnings ```

kayg referenced this issue

2026-10-05 22:04:56 +00:00

Host docs.calternal.com on Cloudflare Pages; add export guides #1143

No labels

No milestone

No project

No assignees

1 participant

Notifications

Due date

The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set

Reference

kayg/calternal#1155

No description provided.

Rows
Columns