TCAI Wiki

Working Conventions

3 min read

TCAI Wiki — Working Conventions

This file is the rulebook for anyone — human or AI — creating or editing pages in this wiki. Read it before making changes. (Claude Code, ChatGPT Codex, and Gemini all read this file first.)

What this is

  • An internal knowledge base for TraumaCare AI (TCAI), written as plain Markdown.
  • Source of truth: the Markdown files in this Google Drive folder. Drive handles sync and per-file version history.
  • No PHI or PII belongs in this wiki, ever.
  • Today we read and edit it in Obsidian (the folder is an Obsidian vault). Later we will publish it as an internal website with Quartz. Every convention below keeps both working, so that transition requires no rework.

Folder structure

  • Top-level folders group pages by domain (add new ones as needed).
  • templates/ — page templates. Copy from here to start a new page. (Quartz ignores this folder by default.)
  • index.md — the home page. Keep its Sections list updated when you add a new domain folder.

File naming

  • One page = one .md file.
  • File names: human-readable Title Case with spaces — e.g. Incident Response.md.
  • Folder names: lowercase-with-hyphens — e.g. clinical-ops/.
  • This gives natural [[wikilinks]] now and clean website URLs later.

Frontmatter (required on every page)

---
title: Incident Response
description: One-line summary used for search and link previews.
tags: [ops, runbook]
draft: false
created: 2026-05-26
updated: 2026-05-26
---
  • title mirrors the file name.
  • draft: true hides a page from the future published site while keeping it visible in Obsidian — use it for work-in-progress.
  • Bump updated: whenever you meaningfully change a page.

Linking

  • Link between pages with wikilinks: [[Incident Response]].
  • Custom display text: [[Incident Response|how we respond to incidents]].
  • Link liberally — “what links here” (backlinks) is generated automatically in both Obsidian and Quartz.

Writing style

  • One topic per page; split a page when it starts to sprawl.
  • Lead with a one-line summary, then the details.
  • Prefer headings, short paragraphs, and lists over walls of text.

Page lifecycle

  • New page: copy a file from templates/, fill in the frontmatter, write the content, and link it from at least one relevant page (and index.md if it opens a new domain).
  • Deprecated page: add the deprecated tag and link to whatever replaces it. Don’t silently delete.

Rules that keep the Quartz transition free — do not break these

  • Keep [[wikilinks]] and YAML frontmatter (both tools depend on them).
  • Keep templates in templates/ (auto-ignored by Quartz).
  • Keep index.md as the home page.
  • Don’t rely on Obsidian-only plugins for core content, and don’t hard-code machine-specific paths.

For AI tools specifically

  • Read this file first and follow the conventions exactly.
  • When you add a page, also: set the frontmatter, link it from at least one existing page, and update the Sections list in index.md if it’s a new domain.
  • Make one logical change per edit; preserve existing structure and links.