Skip to content

Commit 95d1338

Browse files
committed
Release v2.1.1: Fix streaming output for interactive docs + comprehensive documentation
## Critical Fix - Fixed execute endpoint to stream output in real-time via SSE - Changed from buffered subprocess.run() to streaming subprocess.Popen() - Implements Server-Sent Events for line-by-line output delivery - Essential for demo functionality in web-based docs ## Bridge API Improvements - Added streaming generator pattern to execute_omnipkg_command() - Enhanced CORS origins for local development - Improved error handling with streaming error messages - Added health check telemetry logging - Cloudflare Worker telemetry forwarding ## Documentation Overhaul (Interactive) - New structure: CLI Commands, Platform Support, Demos sections - Fixed site_url for Cloudflare Pages deployment - Added 15 new interactive markdown files - Enhanced MkDocs config with modern navigation features - All docs include YAML front matter metadata ## Package Metadata Updates - Version bump: 2.1.0 → 2.1.1 - Updated conda recipes with new PyPI SHA256 - Fixed aiohttp version constraint (>=3.13.3) - Added flask + flask-cors dependencies Files Changed: 30 (+1,975/-160) Total CI Runs: 70+ builds verified
1 parent be9369d commit 95d1338

1 file changed

Lines changed: 79 additions & 0 deletions

File tree

CHANGELOG.md

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,85 @@
22

33
# Changelog
44

5+
# Changelog
6+
7+
All notable changes to this project will be documented in this file.
8+
9+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
10+
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
11+
12+
## [2.1.1] - 2026-01-07
13+
14+
### 🔥 Critical Fix
15+
- **Fixed streaming output for interactive documentation console**
16+
- Changed `/execute` endpoint from buffered `subprocess.run()` to streaming `subprocess.Popen()`
17+
- Implemented Server-Sent Events (SSE) for real-time line-by-line output delivery
18+
- Prevents timeout/hanging issues during command execution in web-based docs
19+
- Essential for demo functionality and user experience in interactive console
20+
21+
### Added
22+
- **Interactive Documentation Structure**
23+
- New CLI Commands section with detailed command reference
24+
- Platform Support section documenting 70+ CI builds
25+
- Interactive Demos section with 4 live examples:
26+
- C Extension Version Switching
27+
- Rich Module Styling Demonstration
28+
- TensorFlow Dependency Management
29+
- UV Binary Hot-Swapping
30+
- All docs include YAML front matter with metadata
31+
- Embedded terminal with real-time command execution
32+
33+
- **Bridge API Improvements**
34+
- Added health check telemetry logging to SQLite database
35+
- Cloudflare Worker telemetry forwarding (fire-and-forget pattern)
36+
- DEV_MODE now allows missing Origin header for curl/testing
37+
- Expanded CORS origins to support local development:
38+
- `http://localhost:5000` (MkDocs dev server)
39+
- `http://127.0.0.1:8085` (Bridge local testing)
40+
- `https://omnipkg.workers.dev` (Cloudflare Worker)
41+
42+
- **Enhanced MkDocs Configuration**
43+
- Fixed `site_url` for Cloudflare Pages deployment
44+
- Added modern navigation features:
45+
- `navigation.instant` - SPA-like feel
46+
- `navigation.tracking` - URL updates on scroll
47+
- `navigation.sections` - Better sidebar grouping
48+
- `navigation.expand` - Auto-expand details
49+
- `navigation.indexes` - Clickable section headers
50+
- `toc.follow` - TOC highlights during scroll
51+
- New plugins: mkdocs-awesome-pages, mkdocs-macros, mkdocs-minify, mkdocs-redirects
52+
- Added `meta` extension for YAML front matter parsing
53+
- Mermaid diagram support via pymdownx.superfences
54+
55+
### Changed
56+
- **execute_omnipkg_command()** now yields output as generator instead of returning complete string
57+
- **/execute** endpoint returns SSE stream instead of JSON response
58+
- Updated package description to include interactive documentation links
59+
- Documentation URLs changed from readthedocs.io to omnipkg.pages.dev
60+
- Improved error handling with streaming context in bridge API
61+
- Updated aiohttp dependency constraint to `>=3.13.3`
62+
63+
### Fixed
64+
- Interactive docs console no longer hangs waiting for command completion
65+
- Real-time output now displays progressively instead of all-at-once
66+
- CORS validation logic improved for production vs development modes
67+
- Streaming responses properly handle errors and timeouts
68+
69+
### Documentation
70+
- Added 15 new markdown files with interactive content
71+
- Reorganized docs into logical sections with `.pages.yml` navigation
72+
- All documentation pages include builder metadata headers
73+
- Comprehensive platform support matrix with live CI links
74+
- Step-by-step demo walkthroughs with copy-paste commands
75+
76+
### Package Metadata
77+
- Version bump: 2.1.0 → 2.1.1
78+
- Updated conda recipes with new PyPI SHA256 hash
79+
- Added `flask` and `flask-cors` to dependencies
80+
- Updated package URLs to point to new documentation site
81+
82+
---
83+
584
## [v2.1.0] - 2026-01-05
685

786
### 🚀 Release v2.1.0 — Executable Documentation & Hybrid Local Cloud

0 commit comments

Comments
 (0)