Skip to content

SEO: system design concepts glossary (/system-design) - #31

Merged
hiabhee merged 1 commit into
mainfrom
feat/system-design-glossary
Nov 7, 2026
Merged

hiabhee merged 1 commit into
mainfrom
feat/system-design-glossary

Conversation

@hiabhee

@hiabhee hiabhee commented Nov 7, 2026

Copy link
Copy Markdown
Owner

Summary

Searches such as "what is a load balancer" and "API gateway system design" are a large long-tail category, and the site had no pages for them. This PR adds a glossary of system design concepts.

  • /system-design: hub page titled "System Design Concepts: Components Explained", listing 20 terms in five groups: traffic and the edge; data and storage; messaging and background work; real time and collaboration; identity. It has DefinedTermSet JSON-LD. It targets "system design concepts", so it doesn't compete with /tutorials for "system design".
  • /system-design/<term>: one static page per term, with the title "X in System Design: How It Works". Each page covers:
    • what it is and how it works;
    • when to use it and its trade-offs;
    • common technologies and an FAQ (DefinedTerm and FAQPage JSON-LD);
    • the architecture diagrams and tutorials that use it, plus related concepts.
  • Content lives in data/glossary/terms.ts. Each term has a match pattern, and lib/site/glossary.ts uses it to classify template and tutorial components. A component's name decides first and its subtitle second, so "API Gateway (Auth + routing)" counts as a gateway, not an auth service.
  • Internal links: component names on template pages link to their term, and tutorial guides get a "Concepts in this design" row. The ChatGPT template now links 11 components and the ChatGPT tutorial 12.
  • Discovery: 21 new sitemap URLs, robots.txt allows /system-design, and the footer gets a "System design concepts" link.

Base: feat/tutorial-templates (#30). Merge in order: #28, #29, #30, then this.

Test plan

  • glossary.test.ts: complete entries, unique slugs, summaries of 160 characters or fewer, every term linked to at least one template or tutorial, name-before-subtitle classification
  • Full frontend suite: 246 files, 1,844 tests pass; tsc and eslint clean
  • Dev server: hub and term pages render (420–750 words) and the sitemap lists 21 /system-design URLs

/system-design lists 20 building blocks (load balancer, API gateway,
CDN, cache, message queue, Kafka, WebSockets, CRDTs, rate limiting,
SQL/NoSQL, vector database, ...). Each /system-design/<term> page covers
what it is, how it works, when to use it, trade-offs, common
technologies and an FAQ (DefinedTerm + FAQPage JSON-LD), and links to
every template and tutorial that uses it.

- lib/site/glossary.ts classifies components by name first, subtitle
  second ("API Gateway (Auth + routing)" is a gateway, not auth).
- Template component names link to their term; tutorial guides list
  "Concepts in this design".
- Sitemap (+21 URLs), robots allow and a footer link.
@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 2:33pm 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: 2c0e4980-e901-444e-b5da-597804a390ab
  • 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/tutorial-templates to main November 7, 2026 15:08
@hiabhee hiabhee closed this Nov 7, 2026
@hiabhee hiabhee reopened this Nov 7, 2026
@hiabhee
hiabhee merged commit 8c1320e into main Nov 7, 2026
6 checks passed
@hiabhee
hiabhee deleted the feat/system-design-glossary branch November 7, 2026 15:16

This branch was successfully deployed

1 active deployment
Preview — edfbc255 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