Repository navigation
docs: illustrate Cloudflare architecture and refresh README - #26
Merged
Merged
Conversation
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.
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.git diff --check: passes.