Skip to content

Conversation

@devin-ai-integration
Copy link
Contributor

@devin-ai-integration devin-ai-integration bot commented Nov 20, 2025

Extract code examples from universal-streaming MDX files

Summary

Extracted inline code examples from 4 MDX documentation pages in the universal-streaming folder into separate language-specific files. This enables language-specific linting, reduces MDX file size, and improves maintainability.

Changes:

  • Moved 4 MDX files into their own folders with code/ subdirectories
  • Extracted 18 code files (Python SDK, Python, JavaScript SDK, JavaScript)
  • Updated MDX files to use <CodeBlocks> component with <Code src="..."/> references
  • Updated docs.yml with new file paths

Files processed:

  • universal-streaming.mdx → 4 code files (all languages)
  • multichannel-streaming.mdx → 4 code files (all languages)
  • multilingual.mdx → 2 code files (Python and JavaScript only, no SDK versions)
  • universal-streaming-keyterms.mdx → 2 code files (Python and JavaScript only, no SDK versions)

Note: This is the first batch for user review. The user requested starting with the universal-streaming folder before proceeding to the remaining 150+ pages.

Review & Testing Checklist for Human

  • Verify extracted code matches original: Spot check 2-3 code files against the original MDX inline code to ensure no content was lost or modified during extraction
  • Test docs rendering: Verify the pages render correctly in staging/production, especially the code blocks with language tabs
  • Check multilingual/keyterms pages: Confirm these pages correctly show only Python and JavaScript tabs (no SDK versions) - this is intentional as the original MDX only had these two languages
  • Verify CI failures are pre-existing: The lint and fern-check failures appear to be pre-existing API spec issues (confirmed by testing on main branch). The "run" check passed successfully.

Test Plan

  1. Deploy to staging and navigate to each of the 4 affected pages
  2. Verify code examples display correctly with proper syntax highlighting
  3. Test language tab switching works for all code blocks
  4. Confirm no broken file references or 404 errors

Notes

CI Status:

  • run check passed
  • lint and fern-check failed with pre-existing API validation errors (same errors exist on main branch)

Session Info:

- Created folder structure for each page with code examples
- Extracted inline code blocks to separate language files (Python SDK, Python, JavaScript SDK, JavaScript)
- Updated MDX files to use CodeBlocks/Code components instead of inline code
- Updated docs.yml with new file paths
- Processed files: universal-streaming.mdx, multichannel-streaming.mdx, multilingual.mdx, universal-streaming-keyterms.mdx

Co-Authored-By: Mart Schweiger <martinschweigerod@gmail.com>
@devin-ai-integration
Copy link
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment and CI monitoring

- multilingual.mdx: Only reference Python and JavaScript (no SDK versions)
- universal-streaming-keyterms.mdx: Only reference Python and JavaScript (no SDK versions)
- These pages don't have SDK code examples, only raw Python/JS implementations

Co-Authored-By: Mart Schweiger <martinschweigerod@gmail.com>
@github-actions
Copy link

@devin-ai-integration devin-ai-integration bot changed the title Extract code examples from MDX files in universal-streaming folder Extract code examples from universal-streaming MDX files Nov 20, 2025
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