Skip to main content

​
Article Guidelines

Use this guide for evergreen lab pages.

​
Where articles belong

  • foundations/
  • patterns/
  • systems/
  • ecosystem/
  • case-studies/
Choose the lane by topic, not by the source chapter that inspired the draft.

​
Required shape

Every article should follow: Required sections:
  • Summary
  • Why It Matters
  • Mental Model
  • Architecture Diagram
  • Tool Landscape
  • Tradeoffs
  • Citations
  • Reading Extensions
  • Update Log

​
Working rules

  • Write in repo-native English.
  • Use source inputs for concepts and citations, not as prose to preserve.
  • Keep diagrams simple and repo-owned.
  • Link to related lab pages so the article is part of the larger map.
  • Keep the page durable. If a claim is likely to age fast, either verify it or write it in non-time-sensitive language.

​
Completion standard

An article is ready for review when it:
  • fits the lane cleanly
  • follows the metadata and section template
  • cites its main sources
  • avoids copied upstream teaching flow
  • includes at least one useful internal reading link