Repository navigation
Introduce Briefing in the README with fresh screenshots - #30
Merged
Merged
Conversation
rcosteira79
marked this pull request as ready for review
October 29, 2026 19:28
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.
The README introduced DiffCompass through the diff view and buried its Briefing documentation under Development. It now leads with the Briefing reader, explains how to inspect diagrams, ask contextual questions, and move into Changes, and includes two fresh screenshots from the current production UI: the narrative with its focused diff, and Present mode with code evidence beside the diagram.
The detailed existing Briefing documentation moves to
docs/briefing.md, with the feature catalogue link updated. Screenshots use the disposable demo and are labelled as prewritten content.Validation: visually inspected both screenshots, exercised the depicted reader and Present interactions with no browser errors, checked all 25 local documentation links/images, and ran
git diff --check. Documentation and image changes only.