Content Conventions¶
These conventions keep our auto‑generated Legal Case, TPIA & Records, Facets, Change Log, and Documents Manifest clean and deterministic.
Front‑matter (minimum)¶
---
title: Descriptive, factual page title
description: One‑sentence summary for SEO and social preview.
date: 2025-10-07 # ISO‑8601 (YYYY-MM-DD)
lastmod: 2025-10-24 # update when materially edited
---
Front‑matter (full, for documents/exhibits)¶
---
title: TPIA Request — TTUHSC Proceedings
description: Initial TPIA request for all proceedings related to the disciplinary case.
date: 2025-10-02
lastmod: 2025-10-24
id: doc-20251002-request # unique site‑wide identifier
kind: document # see allowed kinds below
source: https://example.gov/records/123 # canonical source URL (if any)
redaction_log: /redaction_logs/doc-20251002-request.json
timeline_ids: [ "2025-10-02-req", "2025-10-07-resp" ]
tags: [ tpia, request, document, topic:discipline ]
og_image: assets/social/documents-card.png
---
File naming (documents)¶
Store exhibits/primary docs under docs/docs/
Filename: doc-YYYYMMDD-slug.md (e.g., doc-20251002-request.md)
ID rule: Prefer the same pattern in id:; IDs must be unique site‑wide.
Allowed kind¶
document, email, letter, memo, policy, press, media, tweet, thread, op-ed, post, analysis, timeline, filing, order, motion, hearing, transcript, due-process, appeal, request, response, ag-ruling, production-log
Tags (keep them simple)¶
Domains - legal, tpia, ferpa, foia, public-records
TPIA stages - request, response, ag-ruling, production-log
Legal stages - filing, order, motion, hearing, transcript, due-process, appeal
Types - document, email, letter, memo, policy, press, media, tweet, thread, op-ed, post, analysis, timeline
Open prefixes (free‑form) - topic:*, actor:*, ref:* are allowed without enumeration.
Examples: topic:covid, actor:ttuhsc, ref:ag-op-OR2025-12345
Do / Don’t¶
- Do use
date= creation/publication date of the item; updatelastmodwhen you edit. - Do supply
sourcewhen the doc came from a public host. - Do add
redaction_logfor redacted PDFs, pointing to a public JSON log. - Don’t invent new baseline tags when an existing one fits (keeps sections clean).
- Don’t leave
idempty for exhibits; it powers the manifest and cross‑links.
Why this matters¶
- Legal Case and TPIA & Records indexes are auto‑built from tags.
- Facets and RSS rely on
date,tags, andlastmod. - Manifest aids researchers (stable IDs, hashes, links).
See also: Legal Case, TPIA & Records, Browse, Change Log.