Skip to contentSkip to Content
ConventionsHow to add a note

How to add a note

Stable

Running it locally

Install dependencies with pnpm install, then start the development server with pnpm dev. The site serves on http://localhost:3000. Content changes hot-reload; changes to _meta.ts occasionally need a restart.

Adding a page

  1. Create an .mdx file in the right section folder under content/.
  2. Give it frontmatter with a title and a description. The description is what search engines and the card grids show, so write a real sentence.
  3. Put <Status kind="stub" /> immediately under the heading, and raise it as the page matures.
  4. Add the file to that folder’s _meta.ts in the position you want it in the sidebar. A file missing from _meta.ts still renders, but it lands at the end of the sidebar in filesystem order, which is never what you want.

The lab-first workflow

A topic does not start as a section page. It starts as a note.

Writing directly into a section page produces confident prose about something half-understood. Writing into the lab first produces a note with its uncertainty still attached, which is the honest state of most new material.

Before committing

Run all three checks and let each one pass before the next.

CheckCommandCatches
Typespnpm typecheckErrors in components and _meta.ts files
Lintpnpm lintStyle violations, configured to fail on any warning
Buildpnpm buildMDX that does not compile, and broken component usage

Then check that no credential, token or key has crept into a file. Nothing here needs a secret, so anything that looks like one is a mistake.

Last updated on