Skip to content

Add STT and Telemetry domain overview files#356

Draft
Coldaine wants to merge 4 commits intomainfrom
jules-stt-telemetry-overview-11064652610932299584
Draft

Add STT and Telemetry domain overview files#356
Coldaine wants to merge 4 commits intomainfrom
jules-stt-telemetry-overview-11064652610932299584

Conversation

@Coldaine
Copy link
Owner

This submission adds the missing domain overview files for Speech-to-Text (STT) and Telemetry, as required by the MasterDocumentationPlaybook 1.0.1 (4.1).

In addition to creating the overview files, I reorganized existing documentation by moving domain-specific files (logging.md, observability-playbook.md, and stt-parakeet-integration-plan.md) into their respective domain folders. To maintain backward compatibility and follow project standards, I left redirect stubs at the original locations and updated the main documentation index.

All files now include the mandatory frontmatter, including domain_code, version, and review metadata. Documentation naming validation was confirmed using the project's internal validation script.

Fixes #351


PR created automatically by Jules for task 11064652610932299584 started by @Coldaine

- Created `docs/domains/stt/stt-overview.md`
- Created `docs/domains/telemetry/tele-overview.md`
- Moved `stt-parakeet-integration-plan.md` to `docs/domains/stt/`
- Moved `observability-playbook.md` and `logging.md` to `docs/domains/telemetry/`
- Added redirect stubs for moved files
- Updated metadata headers in all touched files to comply with MasterDocumentationPlaybook
- Updated `docs/index.md` with new file locations
- Verified documentation naming compliance via script

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@google-labs-jules
Copy link
Contributor

👋 Jules, reporting for duty! I'm here to lend a hand with this pull request.

When you start a review, I'll add a 👀 emoji to each comment to let you know I've read it. I'll focus on feedback directed at me and will do my best to stay out of conversations between you and other bots or reviewers to keep the noise down.

I'll push a commit with your requested changes shortly after. Please note there might be a delay between these steps, but rest assured I'm on the job!

For more direct control, you can switch me to Reactive Mode. When this mode is on, I will only act on comments where you specifically mention me with @jules. You can find this option in the Pull Request section of your global Jules UI settings. You can always switch back!

New to Jules? Learn more at jules.google/docs.


For security, I will only act on instructions from the user who triggered this task.

- Added missing `freshness` and `preservation` fields to new overview files
- Fixed redirect stubs by adding complete frontmatter with `status: deprecated` and `preservation: delete`
- Resolved placement-drift for `tele-observability-playbook.md` by changing `doc_type` to `reference`
- Regenerated `docs/index.md` to include all new and reorganized files
- Ensured CI compliance for documentation metadata and placement

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
Coldaine and others added 2 commits February 13, 2026 15:53
- Added `docs/domains/stt/stt-overview.md` and `docs/domains/telemetry/tele-overview.md`
- Migrated domain-specific documentation to domain folders
- Fixed documentation metadata headers (freshness, preservation, subsystem)
- Regenerated documentation index
- Updated `bytes` to 1.11.1 and `time` to 0.3.47 to resolve RUSTSEC-2026-0007 and RUSTSEC-2026-0009

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
- Merged `origin/main` to align with latest documentation cleanup
- Changed redirect stubs' `doc_type` to `index` to resolve placement-drift warnings
- Set redirect stubs' `freshness` to `stale` and `preservation` to `delete`
- Regenerated `docs/index.md` to reflect latest filesystem state
- Maintained security updates for `bytes` and `time` crates

Co-authored-by: google-labs-jules[bot] <161369871+google-labs-jules[bot]@users.noreply.github.com>
@qodo-free-for-open-source-projects

CI Feedback 🧐

A test triggered by this PR failed. Here is an AI-generated analysis of the failure:

Action: CI Success Summary

Failed stage: Generate CI Report [❌]

Failed test name: ""

Failure summary:

The action failed in the CI report/summary step because a required upstream job did not succeed:
-
setup-whisper-dependencies is reported as cancelled (line 128), but the script enforces success:
-
if [[ "cancelled" != "success" ]]; then echo "::error::Setup Whisper dependencies failed."; exit 1;
fi (line 133)
- This caused the workflow to emit ##[error]Setup Whisper dependencies failed. (line
146) and exit with code 1 (line 147).
Additional blocking conditions were also present:
-
unit_tests_hosted and text_injection_tests are skipped (lines 130–131), and the script would also
exit 1 for these because it requires success (lines 135–136).

Relevant error logs:
1:  ##[group]Runner Image Provisioner
2:  Hosted Compute Agent
...

118:  Or undo this operation with:
119:  git switch -
120:  Turn off this advice by setting config variable advice.detachedHead to false
121:  HEAD is now at 438a9dc Merge 6e60b8574e83482f174879e51e40dbe52d0f990c into 9b20395fd32fe10b42eb09464a55455931580a7e
122:  ##[endgroup]
123:  [command]/usr/bin/git log -1 --format=%H
124:  438a9dc448a4d11764541e3e145918a9896ed9f3
125:  ##[group]Run echo "## CI Report" > report.md
126:  �[36;1mecho "## CI Report" > report.md�[0m
127:  �[36;1mecho "- validate-workflows:            cancelled" >> report.md�[0m
128:  �[36;1mecho "- setup-whisper-dependencies:    cancelled" >> report.md�[0m
129:  �[36;1mecho "- security_audit:                success" >> report.md�[0m
130:  �[36;1mecho "- unit_tests_hosted:             skipped" >> report.md�[0m
131:  �[36;1mecho "- text_injection_tests:          skipped" >> report.md�[0m
132:  �[36;1mecho "- moonshine_check:               cancelled (optional)" >> report.md�[0m
133:  �[36;1mif [[ "cancelled" != "success" ]]; then echo "::error::Setup Whisper dependencies failed."; exit 1; fi�[0m
134:  �[36;1mif [[ "success" != "success" ]]; then echo "::warning::Security audit failed - check for vulnerabilities."; fi�[0m
135:  �[36;1mif [[ "skipped" != "success" ]]; then echo "::error::Build and check failed."; exit 1; fi�[0m
136:  �[36;1mif [[ "skipped" != "success" ]]; then echo "::error::Text injection tests failed."; exit 1; fi�[0m
137:  �[36;1mif [[ "cancelled" != "success" ]]; then echo "::warning::Moonshine check failed (optional)."; fi�[0m
138:  �[36;1mecho "All critical stages passed successfully."�[0m
139:  shell: /usr/bin/bash --noprofile --norc -e -o pipefail {0}
140:  env:
141:  CARGO_TERM_COLOR: always
142:  WHISPER_MODEL_SIZE: tiny
143:  MIN_FREE_DISK_GB: 10
144:  MAX_LOAD_AVERAGE: 5
145:  ##[endgroup]
146:  ##[error]Setup Whisper dependencies failed.
147:  ##[error]Process completed with exit code 1.
148:  Post job cleanup.

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.

Add missing STT and Telemetry domain overview files

1 participant

Comments