Repository navigation
Conversation
2 tasks
Publish the guide at /hermes/ and keep the coverage report at /hermes/coverage/ so GitHub Pages can serve both. Diagrams are hand-drawn Excalidraw SVGs generated from docs/diagrams/*.mmd, with light and dark variants and the Excalifont font embedded. The docs link check also fails when the generated files are out of date. Co-authored-by: Tomas Majer <tomasmajer@gmail.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
| echo "Open [index.html](./index.html) for the line-by-line report." | ||
| echo | ||
| echo "- Commit: ${{ github.event.workflow_run.head_sha }}" | ||
| echo "- Branch: ${{ github.event.workflow_run.head_branch }}" |
tomaj
marked this pull request as ready for review
October 13, 2026 07:40
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.
Description
VitePress documentation for Hermes 5.x, served at
/hermes/.GitHub Pages currently publishes the PHPUnit HTML coverage report at the site root. This change builds the guide and, after the test workflow succeeds on
master, copies that samecoverage-reportartifact to/hermes/coverage/inside one Pages deploy. The standalone coverage workflow is removed so the two jobs cannot overwrite each other. The docs deploy listens for a workflow namedCIorPHPUnit, so it still runs after the PHP 8.4 CI lands.The home illustration is an inline SVG. Envelopes move from
emit()into the high, default, and scheduled lanes, then tohandle(), where a check appears. One envelope fails and travels back along the retry path.prefers-reduced-motionleaves a static frame. Light and dark colors follow the theme.Examples follow the 5.x signatures in
src/. Slovak pages and a 6.x tree are not included.docs/site-nav.tsanddocs/guide/versioning.mdare the places to add them.Type of change
Testing
composer phpunitcomposer phpstancomposer phpcsNo PHP sources changed.
docs/scripts/check-links.shbuilds the site, checks that every SVG is well-formed XML, checks that generated GitHub edit andblob/masterlinks match files in the repo, and crawls the site at base/hermes/. Edit links are not requested from GitHub.Documentation
CHANGELOG.mdupdated for a user-visible changeREADME.mdupdated, if the public usage changedCHANGELOG.mdis unchanged. This is not a library release. The docs changelog page follows the existing file and the 5.0.0 release notes.Checklist
The library tests are unchanged. The documentation check is the link and SVG script above.
Pages
/Home, with the animated hero/guide/getting-startedGetting started and quickstart/guide/conceptsMessage, Emitter, Dispatcher, Handler, Driver/guide/architectureArchitecture/guide/drivers/Driver comparison/guide/drivers/redisRedis (ext-redis)/guide/drivers/predisPredis/guide/drivers/rabbitmqRabbitMQ lazy/guide/drivers/sqsAmazon SQS/guide/retryRetry/guide/delayedDelayed execution/guide/priorityPriority, including issue 50/guide/shutdownMax items and graceful shutdown (file, Redis, Predis)/guide/loggingLogging/guide/testingTesting/guide/deploymentSupervisor, systemd, Kubernetes/guide/extendingCustom driver, handler, serializer, shutdown/guide/versioningWhere 6.x and Slovak pages go later/api/referenceAPI reference/faqFAQ/changelogChangelog/contributingContributingDiagrams
All 30 diagrams are hand-drawn Excalidraw style (no fill, light and dark SVGs) generated from
docs/diagrams/*.mmdwithnpm run diagrams;diagrams:checkin CI fails if the committed SVGs are stale.emittohandleZREMno_ackconsume, and the consume sequencecreateQueue, receive, delete beforehandle, visibility timeout notearray_reverse(issue 50)handle()versusDummyDriverMessageInterface,DriverInterface,HandlerInterface,Emitter,Dispatcher