Add screenshots to README and improve documentation#12
Merged
danielbodnar merged 5 commits intomainfrom Jan 14, 2026
Merged
Conversation
Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com>
Co-authored-by: danielbodnar <1790726+danielbodnar@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Add screenshots to README with Playwright or Puppeteer
Add screenshots to README and improve documentation
Jan 14, 2026
There was a problem hiding this comment.
Pull request overview
This PR adds visual documentation to the README through screenshots of the project website and improves the overall documentation structure. The changes enhance readability by reducing emoji usage and adding practical examples.
Changes:
- Added screenshot images and integrated them into README.md with a hero image and collapsible section for additional screenshots
- Reduced emoji density throughout README.md tables and headings for improved readability
- Added Quick Start section with practical tenant creation example
- Filled in previously placeholder sections (License, Contributing, Support, Project Status)
- Added Playwright dependencies to package.json for screenshot tooling
- Alphabetically sorted package.json dependencies
Reviewed changes
Copilot reviewed 2 out of 7 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| package.json | Added Playwright/test dependencies and alphabetically sorted all dependency entries |
| README.md | Added screenshot images, removed excessive emojis, added Quick Start guide, and completed placeholder sections |
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Daniel Bodnar <1790726+danielbodnar@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> Signed-off-by: Daniel Bodnar <1790726+danielbodnar@users.noreply.github.com>
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.
Adds website screenshots to README.md and cleans up documentation formatting.
Changes
Screenshots
<details>sectiondocs/images/for reliabilityREADME cleanup
Screenshot
Additional pages
Warning
Firewall rules blocked me from connecting to one or more addresses (expand for details)
I tried to connect to the following addresses, but was blocked by firewall rules:
https://storage.googleapis.com/chrome-for-testing-public/143.0.7499.4/linux64/chrome-headless-shell-linux64.zip/usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/bitbuilder-hypervisor/bitbuilder-hypervisor/node_modules/playwright-core/lib/server/registry/oopDownloadBrowserMain.js(http block)https://storage.googleapis.com/chrome-for-testing-public/143.0.7499.4/linux64/chrome-linux64.zip/usr/local/bin/node /usr/local/bin/node /home/REDACTED/work/bitbuilder-hypervisor/bitbuilder-hypervisor/node_modules/playwright-core/lib/server/registry/oopDownloadBrowserMain.js(http block)If you need me to access, download, or install something from one of these locations, you can either:
Original prompt
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.