10/15/2026

Content format and reading routes

A practical reference for the actual frontmatter fields, directories and verification commands.

documentationfrontmattercontent

Content format and reading routes

The public reading room uses four directories: diary, knowledge, docs and ideas. A category plus an MDX filename without its extension forms an entry URL. Entry bodies use Markdown headings, lists, links and fenced code.

Required metadata for this collection

---
title: "A specific technical question"
description: "What the reader can reproduce or decide."
date: "2026-10-15"
tags: ["testing", "public-note"]
---

Use a real editorial date and a title describing the finished entry. An idea should identify itself as a proposal. A public lab note should state its inputs and limits rather than imply a real-life event.

Verify a change

From the repository root, run npm test to load every category, check metadata and render the entry bodies. Run npm run lint, npm run typecheck and npm run build for the application checks. Preview the actual reading URL after the build when changing a slug or renderer.

Do not add credentials, internal links, private transcripts, personal schedules or customer material to examples. Use synthetic records. A passing parser proves that a document can load; it does not establish permission to publish its contents. The publication policy supplies that separate editorial gate.