Zaxy v1 Release Docs and Media Implementation Plan
For agentic workers: REQUIRED SUB-SKILL: Use superpowers:subagent-driven-development (recommended) or superpowers:executing-plans to implement this plan task-by-task. Steps use checkbox (- [ ]) syntax for tracking.
Goal: Ship the v1.0.0 docs/media polish package for the public release.
Architecture: Keep release content as repo-native Markdown, generated static HTML, and workspace-local media assets. Use generated bitmap imagery for the header, deterministic Python frame generation plus ffmpeg for the demo, and existing docs validation for link/render correctness.
Tech Stack: Markdown, static HTML/CSS, Python/Pillow, ffmpeg, existing docs builder and pytest docs/package tests.
---
Task 1: Align Release-Facing Version and Site Text
Files:
- Modify:
pyproject.toml - Modify:
CHANGELOG.md - Modify:
README.md - Modify:
site/index.html - Modify:
tests/test_docs_site.py - Modify:
tests/test_packaging.py
- [ ] Update package metadata from
0.4.0/beta to1.0.0/stable. - [ ] Update README and homepage links from release-candidate language to stable v1.0.0 language.
- [ ] Update homepage proof strip to the latest verified release gate facts:
1972 passed,1 skipped,11 deselected,92.04% coverage, andPyPI 1.0.0. - [ ] Update tests that intentionally assert public release text.
Task 2: Add Public Release Article and Verification Request
Files:
- Modify:
docs/announcements/zaxy-v1.0.md - Create:
docs/announcements/zaxy-v1.0-x-article.md - Modify:
.github/ISSUE_TEMPLATE/external_validation.md
- [ ] Convert the v1 announcement title and copy from release candidate to stable release language.
- [ ] Add a public request for external verification with exact commands and the external validation issue path.
- [ ] Add an X-ready article/thread draft that can be posted directly.
- [ ] Keep the external verification request honest: optional, post-release, and requesting failures as well as successes.
Task 3: Create Header Image and Scripted Demo Media
Files:
- Create:
docs/assets/zaxy-v1-header.png - Create:
docs/media/zaxy-collaborate-demo.md - Create:
docs/media/zaxy-collaborate-demo.mp4 - Create:
docs/media/zaxy-collaborate-demo.gif - Create:
scripts/generate-release-media.py
- [ ] Generate or place a polished v1 release header image.
- [ ] Add a deterministic media script that creates demo frames and encodes MP4/GIF assets using
ffmpeg. - [ ] Add a demo storyboard document explaining what the scripted asset shows.
- [ ] Reference the media from announcement/docs where appropriate.
Task 4: Regenerate and Validate Documentation
Files:
- Modify:
site/**/*.htmlgenerated byscripts/build-site-docs.py.
- [ ] Run
python scripts/build-site-docs.py. - [ ] Run
python scripts/build-site-docs.py --check. - [ ] Run
scripts/validate-docs.sh --root .. - [ ] Run focused tests for docs, package version, and release metadata.