Skip to content

docs: professional README with full feature set and fresh screenshots#446

Merged
shyim merged 2 commits into
FriendsOfShopware:mainfrom
roboshyim:docs/professional-readme-screenshots
Jul 23, 2026
Merged

docs: professional README with full feature set and fresh screenshots#446
shyim merged 2 commits into
FriendsOfShopware:mainfrom
roboshyim:docs/professional-readme-screenshots

Conversation

@roboshyim

Copy link
Copy Markdown
Contributor

What changed?

Completely rewrites the project README so it matches what Frosh Tools actually ships today, and replaces the old external Imgur screenshots with in-repo captures from a live Shopware 6.7 Administration.

README structure

  • Clear positioning / “why Frosh Tools”
  • Feature matrix (Admin module + header health badge + CLI)
  • Fresh screenshots under docs/images/
  • Installation (Composer / Store / Git)
  • Configuration (frosh_tools.yaml + system config + schema link)
  • Monitoring / CI hooks (frosh:monitor, frosh-tools:health-check-json, SBOM export)
  • Development notes

Features now documented (were missing or incomplete before)

  • Security Center (advisories, EOL, file integrity, CycloneDX SBOM export)
  • Statistics (OPcache / cache / DB metrics)
  • Queue browse / retry / purge / worker heartbeat
  • Feature Flags
  • Webhooks module (list/detail + search)
  • Fastly, Shopmon
  • frosh-tools:health-check-json, Twig warmup, Redis helpers, extension checksums
  • Admin header health badge

Screenshots (Shopware 6.7.2.2)

docs/images/: system-status, security-center, cache, statistics, queue, scheduled-tasks, state-machines, log-viewer, feature-flags, webhooks, elasticsearch

Why?

The previous README still described a smaller feature set and pointed at stale Imgur URLs. New contributors and store visitors should see the full product surface with current UI chrome.

How was this tested?

  • Installed FroshTools into a dockware Shopware 6.7.2.2 instance
  • Built administration assets
  • Navigated each Tools route in the browser and captured screenshots
  • Verified image paths render relative to the repo root

Related issue or discussion

N/A — docs-only improvement.

Rewrite the project README to match the current Tools module (Security
Center, Statistics, Webhooks, Shopmon, Fastly, SBOM export, queue browse,
feature flags, and more). Replace stale Imgur screenshots with in-repo
captures from Shopware 6.7 Administration under docs/images/.
@greptile-apps

greptile-apps Bot commented Jul 23, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

Rewrites the project README to document the current Frosh Tools feature set, installation, configuration, monitoring, and development workflows, while replacing external screenshots with in-repository WebP captures.

Confidence Score: 5/5

The PR appears safe to merge because no additional blocking failures eligible for this follow-up review were identified.

No blocking failure remains beyond the issues already covered by the existing review threads.

Important Files Changed

Filename Overview
README.md Reorganizes and substantially expands product, setup, configuration, CLI, and development documentation.
docs/images/system-status.webp Adds an in-repository Administration screenshot for the System Status feature.
docs/images/security-center.webp Adds an in-repository Administration screenshot for the Security Center feature.
docs/images/cache.webp Adds an in-repository Administration screenshot for the Cache Manager feature.
docs/images/statistics.webp Adds an in-repository Administration screenshot for the Statistics feature.
docs/images/queue.webp Adds an in-repository Administration screenshot for the Queue Manager feature.
docs/images/scheduled-tasks.webp Adds an in-repository Administration screenshot for Scheduled Tasks.
docs/images/state-machines.webp Adds an in-repository Administration screenshot for the State Machine Viewer.
docs/images/log-viewer.webp Adds an in-repository Administration screenshot for the Log Viewer.
docs/images/feature-flags.webp Adds an in-repository Administration screenshot for Feature Flags.
docs/images/webhooks.webp Adds an in-repository Administration screenshot for Webhooks.

Reviews (2): Last reviewed commit: "docs: full-HD WebP screenshots, drop low..." | Re-trigger Greptile

Comment thread README.md
Comment thread README.md
Comment thread README.md
Recapture Tools UI at 1920×1080 via Playwright, remove Shopware update
toasts, keep only valuable screens (drop disabled ES / Shopmon CTA empty
states), convert to WebP (~48% smaller than PNG), and point README at
the new assets.
@shyim
shyim merged commit f4ec3da into FriendsOfShopware:main Jul 23, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants