docs: progressive disclosure updates from xai extension work#2165
Open
BenWeekes wants to merge 5 commits into
Open
docs: progressive disclosure updates from xai extension work#2165BenWeekes wants to merge 5 commits into
BenWeekes wants to merge 5 commits into
Conversation
request_event_interval_ms is the wall-clock between first and last audio chunk arrival for the request id, not TTFB. Add explicit note alongside the example so future TTS extension authors do not confuse the two.
added 3 commits
May 18, 2026 04:40
The L1 docs mix bare `docker exec` and `sudo docker exec` examples. On hosts where the current user is not in the docker group, only the sudo form works, and the failure mode is a permission-denied error on the unix socket. Add a note in 01_setup.md and a gotcha entry so agents and humans pick the working form on first try instead of giving up after the first bare invocation.
The Formatting section already lists task format and task check, but nothing makes clear that committing from a host shell skips the pre-commit hook and the lint CI check will then fail. Add a callout in 04_conventions.md and a gotcha entry in 07_gotchas.md so agents and humans run the formatter before push instead of discovering it on CI.
The earlier callout only mentioned task check (black). CI also runs task lint (pylint, strict — any warning is fatal), and an unused-import after a refactor can fail the build. Update both 04_conventions.md and 07_gotchas.md so the pre-push command runs format, check, and lint together.
BenWeekes
changed the title
Three changes from the AgoraIO-Community/ai-devkit spec sync: - Rename L2 directory from docs/ai/L1/deep_dives to docs/ai/L1/L2 to match the standard's canonical path. Update every internal link in L1 to point at the new location. - Bump last_reviewed in L0_repo_card.md to 2026-05-18 (was 2026-04-07). - Trim L1 by removing duplicated content. 05_workflows.md no longer reproduces the full nuclear restart command sequence or the long Run Tests / Build and Install / Pre-Commit Checks code blocks; each now links to the section that already covers the detail in L1 (01_setup, 04_conventions) or L2 (testing, operations_restarts). 06_interfaces.md moves the verbose canonical asr_result and error payload JSON examples into L2/extension_development.md and keeps the per-field rules summarized in L1. Total L1 size 1244 -> 1213 lines; further trim requires content review beyond mechanical deduplication.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Clarify the semantics of
request_event_interval_msin thetts_audio_endexample at
docs/ai/L1/deep_dives/extension_development.mdso future TTSextension authors do not confuse it with TTFB.
Per maintainer feedback on #2146, the field represents wall-clock between
the first audio chunk arrival and the last audio chunk arrival for the
request id — the audio receive window — not TTFB (which is reported
separately via the
metricschannel).Test plan