Skip to content

Serve the state diagram from the docs site and drop the contributors image #511

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
em3s merged 2 commits into from
Oct 14, 2026
Merged

Serve the state diagram from the docs site and drop the contributors image #511

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
50f03d7
Serve the state diagram and contributors image from the docs site
em3s Oct 14, 2026
c9423cf
Drop the Contributors section instead of snapshotting it
em3s Oct 14, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions website/public/images/design/mutation-state-transitions.svg
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
26 changes: 26 additions & 0 deletions website/scripts/snapshot-remote-images.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
/**
* Re-fetch the mutation state diagram, which used to be loaded from plantuml.com at view time.
*
* The docs serve a committed snapshot so the page keeps working if plantuml.com changes.
* The source is the "Edit on PlantUML" link in design/mutation.mdx: edit the diagram there,
* update the link, then re-run this.
*
* To go back to the live render instead, point the Markdown image at the source URL below.
*
* Usage (from website/):
* node scripts/snapshot-remote-images.mjs
*/

import { readFile, writeFile } from 'fs/promises';

const mutationDoc = await readFile('src/content/docs/design/mutation.mdx', 'utf8');
const [, plantumlEncoded] = mutationDoc.match(/plantuml\.com\/plantuml\/uml\/([\w-]+)/) ?? [];
if (!plantumlEncoded) throw new Error('No "Edit on PlantUML" link found in design/mutation.mdx');

const source = `https://www.plantuml.com/plantuml/svg/${plantumlEncoded}`;
const target = 'public/images/design/mutation-state-transitions.svg';

const res = await fetch(source);
if (!res.ok) throw new Error(`${source} responded ${res.status}`);
await writeFile(target, Buffer.from(await res.arrayBuffer()));
console.log(`${target} <- ${source}`);
4 changes: 0 additions & 4 deletions website/src/content/docs/community.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,3 @@ Welcome to the Actionbase community. Here you'll find everything you need to par
href="https://github.com/kakao/actionbase/blob/main/SECURITY.md"
/>
</CardGrid>

## Contributors

[![contributors](https://contrib.rocks/image?repo=kakao/actionbase)](https://github.com/kakao/actionbase/graphs/contributors)
2 changes: 1 addition & 1 deletion website/src/content/docs/design/mutation.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ flowchart LR
<details>
<summary>Full state transition diagram</summary>

![Full State Transition Diagram](https://www.plantuml.com/plantuml/png/VPAnRiCW48PtdkAaRbLHcvKXYXKOaAoeIjmkYGTgKpKgmPKDxUlNLiw94JQJBOxlkn-uJUTKw_p5aFx7QP0xMSWi1mQgSkTVpS2UnrgsBUIxc9HSw_MDYwgVodIQaEDZ2PIk9-R3q9AGSO4U7pwCroLTtpiqFwm73c9VdAogAWQhanqQ-Ox1TY-oGl2HHtc0lhtoVWkYBtTKybnC-xQwBcEQYrp4zBZE2S7TwU0HZwbuWAlg6_bq-fZ7_4zrurpY6F0CLlz1qmuVZbAw2ayrOrNTrzKwxsnC3GltI-Gkl22Ck71FGK2PUkxGEec8fT1x3Rau0_4Zf8Se8KXDqG9EDjhM_cB-0G00)
![Full State Transition Diagram](/images/design/mutation-state-transitions.svg)

[Edit on PlantUML](https://www.plantuml.com/plantuml/uml/VPAnRiCW48PtdkAaRbLHcvKXYXKOaAoeIjmkYGTgKpKgmPKDxUlNLiw94JQJBOxlkn-uJUTKw_p5aFx7QP0xMSWi1mQgSkTVpS2UnrgsBUIxc9HSw_MDYwgVodIQaEDZ2PIk9-R3q9AGSO4U7pwCroLTtpiqFwm73c9VdAogAWQhanqQ-Ox1TY-oGl2HHtc0lhtoVWkYBtTKybnC-xQwBcEQYrp4zBZE2S7TwU0HZwbuWAlg6_bq-fZ7_4zrurpY6F0CLlz1qmuVZbAw2ayrOrNTrzKwxsnC3GltI-Gkl22Ck71FGK2PUkxGEec8fT1x3Rau0_4Zf8Se8KXDqG9EDjhM_cB-0G00)

Expand Down
Loading