Commit b284b34
fix(ci): fix release automation — add version_toml, gate PyPI publish (#987)
* docs: add terminal output examples and success indicators to quick start
Enhanced the Quick Start section with:
- "What You'll See" sections showing example terminal output for each command
- Clear success indicators to help users verify things are working
- Structured subsections for Installation, Collect, Learn, and Evaluate
This addresses Phase 1 quick wins from documentation review (task a4441ff):
highest value improvements that help users know when things are working correctly.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* docs: fix stars rendering and add new feature documentation
Fix critical markdown rendering issue where "software **adapt**er" displayed
with literal stars instead of bold formatting. Update package documentation
with comprehensive coverage of new features: episode segmentation, recording
catalog, advanced search, and screenshot automation.
Changes:
- Fix: Remove nested bold formatting causing stars to render literally
- Add: Screenshot autogeneration script (450 lines, Playwright-based)
- Add: Episode segmentation documentation (ML package)
- Add: Recording catalog system documentation (viewer package)
- Add: Advanced search documentation (viewer package)
- Add: Component library reference (viewer package)
- Add: Comprehensive change summary (DOCS_UPDATE_SUMMARY.md)
- Update: Viewer documentation (+148% expansion, 136→336 lines)
- Update: ML documentation (+79% expansion, 155→277 lines)
Files modified:
- docs/index.md (fix stars issue)
- docs/design/landing-page-strategy.md (fix stars issue)
- docs/packages/viewer.md (add new features)
- docs/packages/ml.md (add episode segmentation)
Files created:
- docs/_scripts/generate_docs_screenshots.py (screenshot automation)
- docs/_scripts/README.md (script documentation)
- docs/DOCS_UPDATE_SUMMARY.md (comprehensive summary)
This addresses user-reported issues with documentation quality and ensures
all January 2026 features are properly documented with examples, schemas,
and usage patterns.
Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
* fix(ci): fix release automation — add version_toml config, gate PyPI publish
Two issues fixed:
1. Missing [tool.semantic_release] version_toml config — semantic-release
created tags but never updated pyproject.toml, so poetry kept building
v1.0.0 while tags were at v1.0.4.
2. Build step ran when no release was made — now gated on
steps.release.outputs.released == 'true'.
- Add [tool.semantic_release] section with version_toml pointing to pyproject.toml
- Add id: release to PSR step so outputs are accessible
- Sync pyproject.toml version to 1.0.4 (matches latest tag)
Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
---------
Co-authored-by: Claude Sonnet 4.5 <noreply@anthropic.com>1 parent a3b6876 commit b284b34
2 files changed
+13
-2
lines changed| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
38 | 38 | | |
39 | 39 | | |
40 | 40 | | |
| 41 | + | |
41 | 42 | | |
42 | 43 | | |
43 | 44 | | |
44 | 45 | | |
45 | 46 | | |
46 | 47 | | |
47 | 48 | | |
48 | | - | |
| 49 | + | |
49 | 50 | | |
50 | 51 | | |
51 | 52 | | |
| |||
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
1 | 1 | | |
2 | 2 | | |
3 | | - | |
| 3 | + | |
4 | 4 | | |
5 | 5 | | |
6 | 6 | | |
| |||
91 | 91 | | |
92 | 92 | | |
93 | 93 | | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
0 commit comments