Skip to content

docs: illustrate Cloudflare architecture and refresh README - #26

Merged
fang2hou merged 1 commit into
mainfrom
docs/readme-architecture
Oct 8, 2026
Merged

fang2hou merged 1 commit into
mainfrom
docs/readme-architecture

Conversation

@fang2hou

@fang2hou fang2hou commented Oct 8, 2026

Copy link
Copy Markdown
Owner

Purpose and impact

Make the README useful to developers evaluating or self-hosting share. Remove the maintainer's private instance URL, clarify the self-hosted Cloudflare deployment, and add one architecture diagram covering Workers, per-user SQLite Durable Objects, R2, Static Assets, WebSockets, GitHub OAuth, and Discord's SSR and dynamic OG image flow.

Refresh the first screenshot from the application on the latest main with English UI, a highlighted TypeScript snippet, a plain-text note, and a PNG/CSV/JSON collection. Capture only after fonts and animations settle, with a cream rounded background and transparent corners.

Implementation and risks

The editable diagram source and regeneration script use existing IBM Plex Sans/Mono and resvg dependencies. The script checks all 72 label bounds and outlines the fonts for consistent GitHub rendering. Asset documentation explains regeneration. Changes are limited to documentation, media, and its offline build script; application behavior and deployment settings are unchanged.

Validation

  • node scripts/build-architecture.mjs: all 72 label bounds pass; outlined SVG renders without font buffers.
  • mise run test: quality gate and build pass; 4 favicon tests and 40 Worker integration tests pass.
  • Visual review: architecture text stays inside cards, rounded connectors are consistent, and the screenshot has no mode-switch remnants.
  • PNG inspection: 2080×2310 RGBA, transparent pixels at all four corners, opaque cream background.
  • git diff --check: passes.

@fang2hou
fang2hou merged commit a3fda48 into main Oct 8, 2026
3 checks passed
@fang2hou
fang2hou deleted the docs/readme-architecture branch October 8, 2026 05:12
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