about summary refs log tree commit diff
path: root/tvix/docs/src/SUMMARY.md
diff options
context:
space:
mode:
authortoastal <toastal@posteo.net>2024-06-25T11·28+0700
committertoastal <toastal@posteo.net>2024-06-27T07·16+0000
commitade078141612fb98cf7b93fc2dbcda640610d940 (patch)
tree34f2daf1af3118cce49c8bf8016889f23e4507f3 /tvix/docs/src/SUMMARY.md
parentfbce56b8494998868b3fd841b1d43c2e272603c2 (diff)
docs(tvix): create Welcome + Contributing sections r/8317
A lot of this content needs to be duplicated from the monorepo’s root
directory. However, some of the content was not relevant or could have
been more condensed in descriptions or split up for consumption that
also matched the styles of some other library documentation I had been
looking at for examples. I wanted to add the new access to Admonish
callouts but also aimed at the readablitiy in one’s text editor for the
user that needs to `cat` the docs.

In the future, a “Introduction” page would be nice to add to “Welcome”,
but I don’t think that is as clear.

Change-Id: Ibfc169c5fc3501d7eeb9a76423c6f64cd68897aa
Reviewed-on: https://cl.tvl.fyi/c/depot/+/11869
Tested-by: BuildkiteCI
Reviewed-by: flokli <flokli@flokli.de>
Diffstat (limited to 'tvix/docs/src/SUMMARY.md')
-rw-r--r--tvix/docs/src/SUMMARY.md8
1 files changed, 8 insertions, 0 deletions
diff --git a/tvix/docs/src/SUMMARY.md b/tvix/docs/src/SUMMARY.md
index 633c13683ebb..6b3c43035bf7 100644
--- a/tvix/docs/src/SUMMARY.md
+++ b/tvix/docs/src/SUMMARY.md
@@ -1,5 +1,13 @@
 # Summary
 
+# Welcome
+* [Getting Started](./getting-started.md)
+
+# Contributing
+* [Gerrit](./contributing/gerrit.md)
+* [Email](./contributing/email.md)
+* [Code & Commits](./contributing/code-&-commits.md)
+
 # Tvix
 - [Architecture & data flow](./architecture.md)
 - [TODOs](./TODO.md)