From 994b878476b5bb7fa811fa2821468065c26364e5 Mon Sep 17 00:00:00 2001
From: tinger <me@tinger.dev>
Date: Tue, 23 Jul 2024 17:52:55 +0200
Subject: [PATCH] docs(book): Add outline

This adds a basic outline and introduction to the mdbook.
---
 docs/book/src/README.md  | 30 ++++++++++++++++++++++++++++++
 docs/book/src/SUMMARY.md | 38 ++++++++++++++++++++++++++++++++++++++
 2 files changed, 68 insertions(+)
 create mode 100644 docs/book/src/README.md

diff --git a/docs/book/src/README.md b/docs/book/src/README.md
new file mode 100644
index 0000000..dc687c7
--- /dev/null
+++ b/docs/book/src/README.md
@@ -0,0 +1,30 @@
+# Introduction
+`typst-test` is a test runner for [Typst](https://typst.app/) projects. It helps you worry less about regressions and speeds up your development.
+
+## Bird's-Eye View
+Out of the box `typst-test` supports the following features:
+- locate the project it is invoked in
+- collect and manage test scripts and references
+- compile and run tests
+- compare test output to references
+- provide extra scripting functionality
+- running custom scripts for test automation
+
+## A Closer Look
+This book contains a few sections aimed at answering the most common questions right out the gate.
+- [Installation](./quickstart/install.md) outlines various ways to install `typst-test`.
+- [Usage](./quickstart/usage.md) goes over some basic commands to get started with `typst-test`.
+- [Features](./quickstart/features.md) introduces various concepts to help you use `typst-test` effectively.
+- [Configuration](.quickstart/config.md) explains commonly used configuration keys.
+
+After the quick start a few guides delve deeper into some advanced topics.
+- [Automation](./guides/automation.md) explains the ins and outs of hooks and how they can be used for testing typst preprocessors or formatters.
+- [Using Test Sets](./guides/test-sets.md) delves into the test set language and how it can be used to isolate tests and speed up your TDD workflow.
+- [Setting Up CI](./guides/ci.md) shows how to set up `typst-test` to continously test all changes to your package.
+
+The later sections of the book are a technical reference to `typst-test` and its various features or concepts.
+- [Tests](./reference/tests.md) outlines which types of tests `typst-test` supports, how they can be customized and which features are offered within the test scripts.
+- [Test Set Language](./reference/test-set-dsl.md) defines the test set language and its built in test sets.
+- [Configuration Schema](./reference/config.md) lists all existing config options, their expected types and default values.
+- [Command Line Tool](./reference/cli.md) goes over the `typst-test`s various sub commands, arguments and options.
+
diff --git a/docs/book/src/SUMMARY.md b/docs/book/src/SUMMARY.md
index ac9323c..17e4b70 100644
--- a/docs/book/src/SUMMARY.md
+++ b/docs/book/src/SUMMARY.md
@@ -1 +1,39 @@
 # Summary
+[Introduction](./README.md)
+
+# Quickstart
+- [Installation]()
+- [Usage]()
+- [Concepts]()
+- [Configuration]()
+
+# Guides
+- [Automation]()
+- [Using Test Sets]()
+- [Setting Up CI]()
+
+# Reference
+- [Tests]()
+  - [Reference Kinds]()
+  - [Annotations]()
+  - [Directory Structure]()
+- [Test Set Language]()
+  - [Grammar]()
+  - [Built-in Test Sets]()
+- [Configuration Schema]()
+  - [Template]()
+  - [Hooks]()
+- [Command Line Tool]()
+  - [Global Options]()
+  - [Command Reference]()
+    - [init]()
+    - [uninit]()
+    - [status]()
+    - [list]()
+    - [compile]()
+    - [run]()
+    - [update]()
+    - [add]()
+    - [edit]()
+    - [remove]()
+    - [util]()