Skip to content

Docs/code sync: code-to-docs process + catch-up for #778-#800#802

Merged
spashii merged 2 commits into
mainfrom
sameer/code-to-docs
Jul 6, 2026
Merged

Docs/code sync: code-to-docs process + catch-up for #778-#800#802
spashii merged 2 commits into
mainfrom
sameer/code-to-docs

Conversation

@spashii

@spashii spashii commented Jul 6, 2026

Copy link
Copy Markdown
Member

Sets up the code → docs half of the two-way docs/code sync, saves the process itself as a skill + a docs page, and proves it by running the process over everything merged since the docs corpus was written. (Trigger: docs.echo-next.dembrane.com/users/host/chat-and-ask.html was stale.)

The process (commit 1)

  • .claude/skills/code-to-docs/SKILL.md — the operational skill: classify the diff (user-observable or not; "no docs impact" is a valid conclusion), map it to pages three ways (owning feature page / every audience retelling / grep the docs for exact strings the diff touched), update FACTS.md first, ground every claim in the code (never the PR description; copy UI labels exactly), trickle to related pages, verify links + build, ship as a PR. Never a direct push — the review is the point.
  • docs/users/developer-internal/maintaining-docs.md — the process documented for humans, including the planned docs → code direction (docs edit becomes the spec, trickles to code by references, also reviewed). Linked from the section index and map.md.

The catch-up run (commit 2)

Input: PRs #778#800 (everything user-visible since the corpus landed on 2026-07-03). Production is still v2.0.5 (2026-06-24) and ENABLE_AGENTIC_CHAT is off in production, so new features carry the dembrane next only tag per the existing convention.

Code change Pages updated
Chat polish + Ask home (#778, #793, #797) & memory/context in chat (#798) _authoring/FACTS.md, features/chat-and-ask.md, users/host/chat-and-ask.md
Assistant memory UI + workspace context (#798) features/account-and-security.md, users/host/account-and-settings.md, users/host/managing-your-workspace.md, FACTS
Monitor + participant funnel (#779#792, #795#796, #800) features/recording.md, users/host/collecting-conversations.md, FACTS
Preview-feature inventory features/dembrane-next.md (3-row table)
Agent internals (tools, proposals, memory scopes, workspace-context prompt line) users/developer-internal/chat-and-agent.md

Checked, deliberately left alone:

Verification: every UI label was copied from source by a code sweep (exact Trans/t strings — this caught four labels that would otherwise have been documented wrong, e.g. the error badge reads Error, not "Transcription error"; the docs-chooser cards are Open documentation / Open chat documentation). All relative links + my new anchors resolve; the site builds clean with folder2website (84 pages; new page reachable from map.md).

Pre-existing issue observed, not fixed here: 27 stale heading anchors on older pages (tiers/roles/partner pages) — links open the right page but don't scroll. Good first target for the next docs sweep.

🤖 Generated with Claude Code

spashii and others added 2 commits July 6, 2026 13:01
The code → docs half of the two-way docs/code sync. The skill
(.claude/skills/code-to-docs) is the operational procedure: classify a
diff, map it to pages three ways (feature / audience / grep for exact
strings), update FACTS.md first, ground every claim in code, verify
links + build, and ship as a review PR. The developer-internal page
documents the process and records the planned docs → code direction.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
…tor)

Ran the code-to-docs process over everything merged since the corpus
was written (v2.0.5 is still the production release, so new features
carry the dembrane-next-only tag):

- FACTS.md: Ask home + agent toolset + assistant memory/context, the
  Monitor route, workspace + user settings sections, account-deletion
  reality (server endpoint only, no UI - do not document a button).
- features/chat-and-ask.md + users/host/chat-and-ask.md (the reported
  stale page): agentic mode as it ships today - Ask home, starter
  chips, Templates menu, progress + Stop, named citations, docs
  answers, proposals-for-review, reach-out, memory.
- features/account-and-security.md + users/host/account-and-settings.md:
  the Assistant memory surface (view + remove, owner-only).
- users/host/managing-your-workspace.md: assistant context + workspace
  memory in General settings.
- features/recording.md + users/host/collecting-conversations.md: the
  Monitor - participant flow lanes, audio warnings, transcription
  progress, Live & recent.
- features/dembrane-next.md: table now lists agentic mode (expanded),
  assistant memory & context, and the Monitor.
- users/developer-internal/chat-and-agent.md: the real 20-tool set,
  proposal flow, memory scopes, workspace-context prompt line.

All UI labels copied from source; site builds (84 pages); new page
linked from map + section index.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
@spashii spashii merged commit 737d96f into main Jul 6, 2026
11 checks passed
spashii added a commit that referenced this pull request Jul 6, 2026
Follow-up to #802 (which caught up docs for #778#800). Documents the
**live mic-level meter** added to the Monitor in #803.

The Monitor now shows a per-recording level meter (from the participant
beacon's `audio_level`, 0..1 RMS) so the host can *see* audio is
actually flowing — not just that chunks are landing — with a soft "check
the mic isn't muted" nudge when it goes silent.

Updated, all grounded in the shipped labels:
- `docs/_authoring/FACTS.md` — Monitor per-conversation rows now list
the mic-level meter
- `docs/features/recording.md` — "Is the audio coming in?" bullet
- `docs/users/host/collecting-conversations.md` — host retelling

Build: `folder2website` clean (84 pages, no broken links/anchors).

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-authored-by: Claude Opus 4.8 <noreply@anthropic.com>
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