Skip to content

docs: trim README and add the BPMN process diagram as SVG - #24

Merged
emaarco merged 4 commits into
mainfrom
emaarco/trim-readme-add-bpmn-svg
Aug 20, 2026
Merged

docs: trim README and add the BPMN process diagram as SVG#24
emaarco merged 4 commits into
mainfrom
emaarco/trim-readme-add-bpmn-svg

Conversation

@emaarco

@emaarco emaarco commented Aug 20, 2026

Copy link
Copy Markdown
Contributor

Shortens the README and makes the process model its lead visual, so the repo reads well as a template for future backend-only variants (which won't have a frontend screenshot but will share the model).

  • Add the bike-leasing BPMN process as the hero image, exported to SVG (replaces the old bike-leasing.png; docs/README.md reference updated).
  • Cut ~40% of the prose: drop the "Technology choices" ADR list that duplicated the table in docs/README.md, condense the scenario, and merge redundant sections.
  • Plainer, more engaging wording throughout (e.g. "architecture kept honest by tests"), and no em-dashes in the body.

@emaarco
emaarco enabled auto-merge (squash) August 20, 2026 13:48
@emaarco
emaarco merged commit ea565ed into main Aug 20, 2026
5 checks passed
@emaarco
emaarco deleted the emaarco/trim-readme-add-bpmn-svg branch August 20, 2026 13:52
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.

1 participant