Fix docs stars rendering and add new feature documentation #986
+1,350
−11
Conversation
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
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 <[email protected]>
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 <[email protected]>
This was referenced Jan 17, 2026
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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
This PR addresses critical documentation issues and brings docs.openadapt.ai in line with the latest OpenAdapt capabilities, particularly the new screenshot autogeneration system developed for openadapt-viewer.
Critical Fixes
**adapt**stars rendering issue - Text "software adapter" was displaying with literal stars instead of bold formattingMajor Improvements
Changes
Files Modified (4)
docs/index.md- Fixed stars issue (line 5)docs/design/landing-page-strategy.md- Fixed stars issue (line 32)docs/packages/viewer.md- Expanded from 136 to 336 lines (+148%)docs/packages/ml.md- Expanded from 155 to 277 lines (+79%)Files Created (3)
docs/_scripts/generate_docs_screenshots.py- Screenshot automation (450 lines)docs/_scripts/README.md- Script documentationdocs/DOCS_UPDATE_SUMMARY.md- Comprehensive summaryTotal Impact
Test Plan
mkdocs build --strict(requires review environment)mkdocs serve(requires review environment)Documentation
All changes are documented in
docs/DOCS_UPDATE_SUMMARY.mdwhich includes:Related Issues
Screenshots
Screenshot automation script is included but screenshots not yet generated.
Run after PR merge:
🤖 Generated with Claude Code