Skip to content

Docs pass: current map, per-area AGENTS.md, archive - #1948

Merged
r3dbars merged 2 commits into
mainfrom
claude/cleanup-docs
Oct 2, 2026
Merged

r3dbars merged 2 commits into
mainfrom
claude/cleanup-docs

Conversation

@r3dbars

@r3dbars r3dbars commented Oct 2, 2026

Copy link
Copy Markdown
Owner

Stacked on #1947 (AGENTS.md everywhere). Once that merges this retargets to main.

Docs only. No code, scripts or tests change.

What changed

  • New AGENTS.md for Sources/Writing/, Sources/TranscriptedWriting/ and Sources/TranscriptedKeyboard/: what each owns, entry points, rules, tests. Written from the code.
  • Sources/AGENTS.md, Sources/TranscriptedCore/AGENTS.md and Sources/UI/Settings/AGENTS.md now cover files they were missing (Writing views, SpeechSegmentPacking, TranscriptFileRewrite, unheard-playback, etc.). Fixed a stale "Nemotron removed" line.
  • docs/README.md indexes every live doc by job. docs/repo-layout.md points at it instead of keeping a second list, adds Sources/Writing/, refreshes hotspots (as of 2026-10-01) and .claude/.
  • docs/archive/ + README: the July speaker-eval JSON output. Everything else dated stays put because code, scripts or tests cite it.
  • README: Writing shipped in 1.1.67, so the "coming in 1.1.67" notes are gone; the download is ~700 MB now (1.1.68 DMG).
  • docs/writing-plan.md says it shipped and points at current docs. Settings spec, meeting-language doc and route-recovery QA doc match today's Settings layout. CONTRIBUTING lists Writing and check.sh; WORKFLOW step 10 uses check.sh.

Left alone on purpose

Checks

  • python3 scripts/dev/check-doc-paths.py: OK (136 files)
  • python3 scripts/dev/check-known-traps.py: OK
  • bash check.sh quick: 59/60. The one failure was scripts/vm/test-transcripted-vm.sh (supervise.py SIGINT timing self-test) under heavy parallel load; it passed 63/63 on a rerun. Unrelated to docs.

Review level: docs-only, so check.sh per AGENTS.md.

🤖 Generated with Claude Code

- New AGENTS.md for Sources/Writing, Sources/TranscriptedWriting and
  Sources/TranscriptedKeyboard, written from the code.
- Sources/AGENTS.md, TranscriptedCore and UI/Settings guides list the files
  they were missing (Writing views, packing, unheard playback, file rewrite).
- docs/README.md indexes every live doc; repo-layout points at it instead of
  keeping a second list, adds Sources/Writing, refreshes hotspots.
- docs/archive/ takes the July speaker-eval JSON output.
- README: Writing shipped in 1.1.67, so the "coming in" notes go; download
  is about 700 MB now.
- writing-plan says it shipped; the settings spec, language picker and
  route-recovery QA docs match the current Settings layout.
@r3dbars

r3dbars commented Oct 2, 2026

Copy link
Copy Markdown
Owner Author

Review verdict: docs only, no code touched. Two review passes. The first found nothing. The second found three doc errors. I checked all three against the code and fixed them in 42b20de.

  1. Fixed. Sources/UI/Settings/AGENTS.md said Nemotron is Core's default. It's only the app's default (Sources/Support/DiarizationBackendPreferences.swift). Core still defaults to pyannote (DiarizationService.swift:82, DiarizationBackend.swift). The line now says that.
  2. Fixed. docs/qa-audio-route-notification-recovery.md pointed testers at a Mac mic recorder switch in Settings, and there isn't one. The recorder ships on (PinnedMicrophoneCapturePreferences.shipsOnByDefault = true). The doc now says the base pass covers it, then gives the defaults write ... pinned-microphone-capture -bool false / TRANSCRIPTED_PINNED_MIC_CAPTURE=0 off pass, run once with Faster Bluetooth dictation off and once on. It also says how to restore the default afterward.
  3. Fixed (low). docs/ui-settings-menubar-spec.md now also lists the second "Transcribe audio file" entry point, the secondary action on the Meetings page's empty state (HomeSettingsPage.swift:176).

Checks: bash check.sh passed everything except build.sh. That failed only because the fresh worktree had no deps yet. build-deps.sh --force then ran in the same pass, and a rerun of bash build.sh --no-open passed. check-doc-paths.py is OK (136 files).

🤖 Generated with Claude Code

@r3dbars
r3dbars deleted the branch main October 2, 2026 06:16
@r3dbars r3dbars closed this Oct 2, 2026
@r3dbars r3dbars reopened this Oct 2, 2026
@r3dbars
r3dbars changed the base branch from claude/cleanup-agents-md to main October 2, 2026 06:17
@r3dbars
r3dbars merged commit 2aee85a into main Oct 2, 2026
16 checks passed
@r3dbars
r3dbars deleted the claude/cleanup-docs branch October 2, 2026 06:37
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