Repository navigation
Refresh documentation and plan usability improvements - #26
Merged
Merged
Conversation
baol
force-pushed
the
codex/documentation-roadmap
branch
from
October 16, 2026 14:43
2cd6b5c to
7694214
Compare
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
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.
Refresh the user and design documentation to describe current behavior directly. Align Fade descriptions across the README, manual, and showcase; correct page shortcuts and test setup; remove historical review labels and package-signing commentary.
Add a focused roadmap for first-run guidance, reference consistency, completion and validation of
--program, presentation help and visible errors, and documentation checks.Consolidate transition media into the generated gallery. Remove 41 committed capture files and the Fade-only generator. The shared gallery supports
--effects Fadewith colored, light, and dark slide pairs, writes captures into the selected build output, and uses neutral gallery labels. Remove the option to write captures into docs.Validation: local documentation links and whitespace checks pass; manual rendered with groff; 48-slide showcase built and updated Fade slide visually checked. Generated and inspected the shared five-frame Fade gallery, verifying PDFs, contact sheets, MP4s, and manifest for all three palettes. Default diagnostic PDFs remain byte-identical. All 231 tests pass; timing results are reported separately from correctness.