Skip to content

Templates: ten architecture diagrams for systems that only had a tutorial - #30

Merged
hiabhee merged 1 commit into
mainfrom
feat/tutorial-templates
Nov 7, 2026
Merged

hiabhee merged 1 commit into
mainfrom
feat/tutorial-templates

Conversation

@hiabhee

@hiabhee hiabhee commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Summary

Ten systems had a system design tutorial but no architecture diagram page, so searches like "WhatsApp architecture diagram" had nowhere to land. This PR adds a template for each, with a written guide:

WhatsApp, Twitter, Airbnb, Discord, Zoom, Spotify, LinkedIn, Figma, GitHub, Rate Limiter

  • Diagrams are hand-drawn in data/templates/tutorial-systems.ts, with 11–18 components and labelled connections. Each contains every component its tutorial teaches, so the template page and the tutorial agree, plus the parts a complete design needs. An earlier version generated them straight from the tutorials, but several tutorials teach only eight components and some of their links read wrongly out of context.
  • Guides follow the same format as SEO: written guides on the first ten template pages #28 and SEO: written guides for the remaining sixteen template pages #29: overview, request flow, design decisions, scaling, and an FAQ with FAQPage JSON-LD. The rendered pages are 916–1,030 words.
  • Templates and tutorials link both ways. templateForTutorial now prefers a template whose main tutorial is this one, so the WhatsApp tutorial links to the WhatsApp template instead of the generic chat system.
  • Named products get the public-information note. The rate limiter is listed with the system design interview classics.

Deliberately not added: YouTube, Stripe, Shopify, DoorDash and Notion. The existing video streaming, payment system, e-commerce, food delivery and collaborative editor templates already cover them and link to those tutorials. A second, near-identical page would compete with the first.

Spotify: the web and mobile clients are a single "Client Apps" node. With two clients each fanning out to both the CDN and the gateway, fan centring measured 75px against the 10px limit. All ten new templates pass the layout-quality checks at the default limits, with no per-template exceptions.

Base: feat/template-guides-2 (#29). Merge #28, then #29, then this.

Test plan

  • Full frontend suite: 245 files, 1,830 tests pass (layout aesthetics and readability cover every template)
  • Guide tests (115 template, site and design-guard tests) pass; tsc and eslint clean
  • Dev server: all ten pages and their diagram-light.svg images return 200; sitemap lists 36 template pages
  • Preview: open each new template in the editor from its page

…a tutorial

New templates, each with a written guide: WhatsApp, Twitter, Airbnb,
Discord, Zoom, Spotify, LinkedIn, Figma, GitHub and a rate limiter.
Each contains every component its system design tutorial teaches plus
the parts a complete design needs, with labelled connections
(data/templates/tutorial-systems.ts).

- Each template links to its tutorial and each tutorial back to its own
  template (a dedicated template now wins over the generic chat system).
- Named products get the public-information note; the rate limiter is
  listed with the interview classics.
- YouTube, Stripe, Shopify, DoorDash and Notion are left out: video
  streaming, payment system, e-commerce, food delivery and collaborative
  editor already cover them, and a second page would compete with it.
- Spotify's clients are one node: two clients each fanning to the CDN
  and gateway broke fan centring (75px vs the 10px limit); all ten new
  templates now pass the layout ratchets at the defaults.
@vercel

vercel Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
arch-draw Ready Ready Preview Nov 7, 2026 1:52pm UTC

@coderabbitai

coderabbitai Bot commented Nov 7, 2026 •

Copy link
Copy Markdown

Important

  • Trigger review

This repository does not receive automatic reviews because it has fewer than 10 stars.

Run configuration

  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: bc24452c-d566-405d-80bf-eaecb9921bdd
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@hiabhee
hiabhee changed the base branch from feat/template-guides-2 to main November 7, 2026 15:00
@hiabhee hiabhee closed this Nov 7, 2026
@hiabhee hiabhee reopened this Nov 7, 2026
@hiabhee
hiabhee merged commit 5d8ee2b into main Nov 7, 2026
6 checks passed
@hiabhee
hiabhee deleted the feat/tutorial-templates branch November 7, 2026 15:08

This branch was successfully deployed

1 active deployment
Preview — 9fb83e69 Deployed Nov 7, 2026 by vercel[bot]
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