docs: restructure README with alerts and better navigation#48
Conversation
- Reorganise sections: Development section now sits before Examples, grouping all setup and usage guidance - Add GitHub alerts for key information: memory safety WARNING, GPL inheritance IMPORTANT, examples TIP, fork attribution and VVenC NOTE - New "Built with FFmpeg Statigo" showcase section with jivedrop, jivefire, jivetalking projects - Elevate `av` package as a key feature: add Features bullet and expand Development subsection with managed-lifetime guidance - Move "Building something that deals with video?" and "What's Intentionally Absent" into Development for design philosophy context Signed-off-by: Martin Wimpress <code@wimpress.io>
- Restructure API-COVERAGE and CODECS with clean H1 titles and intro lines - Add `[!WARNING]` alert in PIPELINE for callback frame lifetime footgun - Add `[!IMPORTANT]` alert in DEVELOPMENT for Nix-only generator constraint - Convert old blockquote note in API-COVERAGE to `[!NOTE]` GitHub alert - Normalise headings: fix buried H1s, title-case shouts, restore single H1 per file - Tighten prose: remove filler, clarify ambiguous phrases, improve readability - Improve intro/opening sentences in reference docs to state purpose upfront Signed-off-by: Martin Wimpress <code@wimpress.io>
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
There was a problem hiding this comment.
0 issues found across 8 files (changes from recent commits).
Auto-approved: All changes are documentation-only: restructuring README.md with better organization and alerts, minor typographical fixes, and consistent formatting across doc files, with no modifications to any source code, configuration, or infrastructure files.
Re-trigger cubic
There was a problem hiding this comment.
No issues found across 9 files
Confidence score: 5/5
- Automated review surfaced no issues in the provided summaries.
- No files require special attention.
Auto-approved: This PR only restructures and improves documentation—adding GitHub alerts, fixing typos, reorganizing sections, and enhancing navigation across README and docs files—with zero changes to source code, business logic, or configuration, making it safe to auto-approve.
Re-trigger cubic
1 participant
avpackage as a key feature: add Features bullet and expand Development subsection with managed-lifetime guidance