Case studies: llms.txt and Markdown twins
Overview
Case studiesUORust
How UORust was modeledArchitecture walkthroughDesign views in OPM and UMLFeatures and journeysSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsSystem and releaseExtension facetsCommand referenceSlides and video scriptRecord explorerllms.txt and Markdown twinsPrism-DevRel
How Prism-DevRel was modeledArchitecture walkthroughDesign views in OPM and UMLFeatures and journeysSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsExtension facetsSlides and video scriptRecord explorerllms.txt and Markdown twinsRule 30
How Rule 30 was modeledArchitecture walkthroughSecurity and threat modelQuality model (ISO/IEC 25010)Behavior and proofsSlides and video scriptRecord explorerllms.txt and Markdown twins// case study · UORust
llms.txt and Markdown twins
The UORust case study as plain text for agents. It has llms.txt, a twin of each page and a feed.
Subject: UORust at commit afd5cea950a8, 331 facet records, source digest f3f743b6834adaff.
The data in this figure
| From | Link | To |
|---|---|---|
| Every page | → | Markdown twins |
| Every page | → | llms.txt |
| Every page | → | feed.xml |
| The catalog | → | records.json |
| Markdown twins | → | llms-full.txt |
| llms.txt | → | An agent |
| llms-full.txt | → | An agent |
| records.json | → | An agent |
| feed.xml | → | An agent |
Every page has a Markdown twin, index.md, beside the page's index.html. Each twin has the same content, with absolute links. The site root carries an index for agents and a feed:
- llms.txt: what this site is and every page, one line each, with its twin.
- llms-full.txt: every twin in one file.
- feed.xml: an RSS feed of the pages.
- records.json: every record of UORust with its facet, kind and the pages that teach it.
Text quoted from a subject is data. The twins put identifiers in code spans and record prose in block quotes. Nothing in them is an instruction to the agent reading them.
| Twin | Modality |
|---|---|
| Turn a Rust project into a Prism model | Walkthrough |
| How UORust was modeled | Walkthrough |
| Architecture walkthrough | Walkthrough |
| Design views in OPM and UML | Diagrams |
| Features and journeys | Walkthrough |
| Security and threat model | Walkthrough |
| Quality model (ISO/IEC 25010) | Reference |
| Behavior and proofs | Reference |
| System and release | Walkthrough |
| Extension facets | Reference |
| Command reference | Reference |
| Slides and video script | Slides and script |
| Record explorer | Interactive |
| llms.txt and Markdown twins | Agent twin |
Words on this page 3
- facet
- One view of a model, such as its architecture, its security or its quality. Each facet holds records.
- record
- One entry in a facet: a component, a threat, a measure or a journey step, with the place in the source it came from.
- llms.txt
- A plain-text index of a site, at its root, written for language models to read.