diff --git a/doc/src/05100-lib-ref.md b/doc/src/05100-lib-ref.md index 146059f1..f1c713b4 100644 --- a/doc/src/05100-lib-ref.md +++ b/doc/src/05100-lib-ref.md @@ -1,4 +1,4 @@ -# libimagref +## libimagref This library crate contains functionality to generate _references_ within the imag store. @@ -20,14 +20,14 @@ Permission changes can be tracked as well. So this library helps to resemble something like a _symlink_. -## Limits +### Limits Please understand that this is _not_ intended to be a version control system or something like that. We also can not use _real symlinks_ as we need imag-store-objects to be able to link stuff. -## Usecase +### Usecase This library offers functionality to refer to content outside of the store. It can be used to refer to _nearly static stuff_ pretty easily - think of a @@ -43,7 +43,7 @@ of files which constantly change... but the first 5 lines do never change after the file is created - you can write a custom hasher that only uses the first 5 lines for the hash. -## Internals +### Internals Internally, in the store, the file gets created under `/ref/`. diff --git a/doc/src/05100-lib-rt.md b/doc/src/05100-lib-rt.md index 204770cb..859eb1b8 100644 --- a/doc/src/05100-lib-rt.md +++ b/doc/src/05100-lib-rt.md @@ -1,4 +1,4 @@ -# libimagrt +## libimagrt This library provides utility functionality for the modules and the binary frontends, such as reading and parsing the configuration file, a builder diff --git a/doc/src/05100-lib-store.md b/doc/src/05100-lib-store.md index 51c9d49d..b87482dc 100644 --- a/doc/src/05100-lib-store.md +++ b/doc/src/05100-lib-store.md @@ -1,4 +1,4 @@ -# libimagstore +## libimagstore The store is the heart of everything. Here lives the data, the complexity and the performance bottleneck. diff --git a/doc/src/05100-lib-util.md b/doc/src/05100-lib-util.md index ba32bcaf..0d38b64c 100644 --- a/doc/src/05100-lib-util.md +++ b/doc/src/05100-lib-util.md @@ -1,4 +1,4 @@ -# libimagutil +## libimagutil Utility library. Does not depend on other imag crates.