From 888028b67497c75146b18239b97669e84a6b5315 Mon Sep 17 00:00:00 2001 From: Florian Klink Date: Wed, 26 Jun 2024 11:06:14 +0300 Subject: docs(tvix): use `#` for toplevel headings See discussion in cl/11869. Let's use `#` consistently, we also use `##` for deeper nested subheadings. Change-Id: Ie25ebda708639fb617d456c275ae5a264fc4ce85 Reviewed-on: https://cl.tvl.fyi/c/depot/+/11881 Autosubmit: flokli Tested-by: BuildkiteCI Reviewed-by: flokli Reviewed-by: toastal --- tvix/docs/src/eval/bindings.md | 3 +-- tvix/docs/src/eval/build-references.md | 3 +-- tvix/docs/src/eval/builtins.md | 3 +-- tvix/docs/src/eval/known-optimisation-potential.md | 3 +-- tvix/docs/src/eval/recursive-attrs.md | 3 +-- tvix/docs/src/eval/vm-loop.md | 3 +-- tvix/docs/src/store/api.md | 3 +-- 7 files changed, 7 insertions(+), 14 deletions(-) (limited to 'tvix/docs/src') diff --git a/tvix/docs/src/eval/bindings.md b/tvix/docs/src/eval/bindings.md index e1c214e49f22..4fb35b623580 100644 --- a/tvix/docs/src/eval/bindings.md +++ b/tvix/docs/src/eval/bindings.md @@ -1,5 +1,4 @@ -Compilation of bindings -======================= +# Compilation of bindings Compilation of Nix bindings is one of the most mind-bending parts of Nix evaluation. The implementation of just the compilation is currently almost 1000 diff --git a/tvix/docs/src/eval/build-references.md b/tvix/docs/src/eval/build-references.md index cfa569c04a2c..dd53f65d83aa 100644 --- a/tvix/docs/src/eval/build-references.md +++ b/tvix/docs/src/eval/build-references.md @@ -1,5 +1,4 @@ -Build references in derivations -=============================== +# Build references in derivations This document describes how build references are calculated in Tvix. Build references are used to determine which store paths should be available to a diff --git a/tvix/docs/src/eval/builtins.md b/tvix/docs/src/eval/builtins.md index dba4c48c65e1..d9fcd72ccab5 100644 --- a/tvix/docs/src/eval/builtins.md +++ b/tvix/docs/src/eval/builtins.md @@ -1,5 +1,4 @@ -Nix builtins -============ +# Nix builtins Nix has a lot of built-in functions, some of which are accessible in the global scope, and some of which are only accessible through the diff --git a/tvix/docs/src/eval/known-optimisation-potential.md b/tvix/docs/src/eval/known-optimisation-potential.md index 0ab185fe1be2..11babcb59ac1 100644 --- a/tvix/docs/src/eval/known-optimisation-potential.md +++ b/tvix/docs/src/eval/known-optimisation-potential.md @@ -1,5 +1,4 @@ -Known Optimisation Potential -============================ +# Known Optimisation Potential There are several areas of the Tvix evaluator code base where potentially large performance gains can be achieved through diff --git a/tvix/docs/src/eval/recursive-attrs.md b/tvix/docs/src/eval/recursive-attrs.md index c30cfd33e6c7..5ce1cb2b64ff 100644 --- a/tvix/docs/src/eval/recursive-attrs.md +++ b/tvix/docs/src/eval/recursive-attrs.md @@ -1,5 +1,4 @@ -Recursive attribute sets -======================== +# Recursive attribute sets The construction behaviour of recursive attribute sets is very specific, and a bit peculiar. diff --git a/tvix/docs/src/eval/vm-loop.md b/tvix/docs/src/eval/vm-loop.md index 6266d34709cb..a75c7eec31df 100644 --- a/tvix/docs/src/eval/vm-loop.md +++ b/tvix/docs/src/eval/vm-loop.md @@ -1,5 +1,4 @@ -tvix-eval VM loop -================= +# tvix-eval VM loop This document describes the new tvix-eval VM execution loop implemented in the chain focusing around cl/8104. diff --git a/tvix/docs/src/store/api.md b/tvix/docs/src/store/api.md index 21c23ab6ad17..b20ec0e8bf5f 100644 --- a/tvix/docs/src/store/api.md +++ b/tvix/docs/src/store/api.md @@ -1,5 +1,4 @@ -tvix-[ca]store API -============== +# tvix-[ca]store API This document outlines the design of the API exposed by tvix-castore and tvix- store, as well as other implementations of this store protocol. -- cgit 1.4.1