Merge pull request #5 from lennyzeltser/docs/simplify-readme-toc

docs: Simplify README table of contents to single level
This commit is contained in:
Lenny Zeltser
2026-01-15 00:21:20 -05:00
committed by GitHub
+11 -26
View File
@@ -4,32 +4,17 @@ Create animated replays of text conversations.
After parsing the annotated conversation data you supply in a YAML file, this tool will generate a self-contained embeddable HTML file. The published conversation can help with security awareness training and other communications that involve presenting an annotated text conversation.
- [Conversation Replay](#conversation-replay)
- [How This Is Useful](#how-this-is-useful)
- [Installation](#installation)
- [Run Without Installing (Recommended)](#run-without-installing-recommended)
- [Global Install](#global-install)
- [Install from GitHub](#install-from-github)
- [Quick Start](#quick-start)
- [YAML Schema](#yaml-schema)
- [Basic Structure](#basic-structure)
- [Step Types](#step-types)
- [Message Options](#message-options)
- [Meta Options](#meta-options)
- [Output Features](#output-features)
- [Embedding in Websites](#embedding-in-websites)
- [Automatic "Seamless" Mode](#automatic-seamless-mode)
- [Basic Iframe Code](#basic-iframe-code)
- [Dark Mode Sync](#dark-mode-sync)
- [Multi-Scenario Demos](#multi-scenario-demos)
- [Development](#development)
- [Repository Structure](#repository-structure)
- [Commands](#commands)
- [AI Agent Quick Reference](#ai-agent-quick-reference)
- [Key Files](#key-files)
- [Architecture](#architecture)
- [Threat Modeling](#threat-modeling)
- [Author](#author)
- [How This Is Useful](#how-this-is-useful)
- [Installation](#installation)
- [Quick Start](#quick-start)
- [YAML Schema](#yaml-schema)
- [Output Features](#output-features)
- [Embedding in Websites](#embedding-in-websites)
- [Multi-Scenario Demos](#multi-scenario-demos)
- [Development](#development)
- [AI Agent Quick Reference](#ai-agent-quick-reference)
- [Threat Modeling](#threat-modeling)
- [Author](#author)
## How This Is Useful