Repository navigation
Add screenshots of every page and an animated tour to the README - #7
Merged
Merged
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
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.
What and why
Adds a screenshot of every page to
docs/images/and an animated tour of the app at the top of the README, so people can see what Knowledge Hubs does before installing it.docs/images/: one 1440×900 screenshot per sidebar tab (Hub, Search, Review, Decisions, Playbooks, GraphRAG, Sources, Groups, Models, Users)docs/images/tour.gif: all ten pages in sidebar order (960×600, 2.5 s per frame, 415 KB)README.md: the GIF replaces the three static images; each page name in the table links to its screenshot; adds rows for Groups, Models and Usersdocs/screenshots.md: new gallery page with every screenshot and a short caption, linked from the README anddocs/README.mdAll screenshots use fictional demo data (a made-up "Platform team"; connector addresses are example.com placeholders).
How it was tested
docker compose up --build) with seeded demo data and captured each page with Playwright; GraphRAG shows a real answer from local Llama 3.1 8Bdocs/resolvesChecklist
pytest), and the frontend tests and build pass (no code changes; CI runs them)docs/are updated if behaviour, configuration or the API changedCHANGELOG.mdhas a line under Unreleased