nix-super/doc/manual/src
Valentin Gagarin 8d9e0b7aed
document the store concept (#9206)
* document the store concept and its purpose

reword the glossary to link to more existing information instead of
repeating it.

move the store documentation to the top of the table of contents, in
front of the Nix language. this will provide a natural place to
document other aspects of the store as well as the various store types.

move the package management section after the Nix language and before
Advanced Topics to follow the pattern to layer more complex concepts on
top of each other.

this structure of the manual will also nudge beginners to learn Nix
bottom-up and hopefully make more likely that they understand underlying
concepts first before delving into complex use cases that may or may not
be easy to implement with what's currently there.

[John adds this note] The sort of beginner who likes to dive straight into reference documentation should prefer this approach. Conversely, the sort of beginner who would prefer the opposite top-down approach of trying to solve problems before they understand everything that is going on is better off reading other tutorial/guide material anyways, and will just "random-access" the reference manual as a last resort. For such random-access the order doesn't matter, so this restructure doesn't make them any worse off.

Co-authored-by: John Ericson <git@JohnEricson.me>
2023-10-25 02:28:35 +00:00
..
advanced-topics Merge how-to section on S3 buckets into S3 store docs (#7972) 2023-10-23 13:22:33 -04:00
architecture document the store concept (#9206) 2023-10-25 02:28:35 +00:00
command-ref nix-shell: support single quotes in shebangs 2023-10-23 15:56:05 +02:00
contributing Get rid of bootstrap.sh 2023-10-09 12:55:58 -04:00
figures Move figures 2020-07-24 12:58:31 +02:00
installation docker: publish images to ghcr.io (#8066) 2023-10-20 19:28:26 +02:00
language Expand derivation examples (#9048) 2023-10-20 15:17:28 -04:00
package-management Merge how-to section on S3 buckets into S3 store docs (#7972) 2023-10-23 13:22:33 -04:00
protocols Allow dynamic derivation deps in inputDrvs 2023-09-07 10:39:37 -04:00
release-notes Release notes updated for #9150 reverted (#9227) 2023-10-24 11:18:00 +02:00
store document the store concept (#9206) 2023-10-25 02:28:35 +00:00
glossary.md document the store concept (#9206) 2023-10-25 02:28:35 +00:00
introduction.md Convert short nix options to long ones 2023-05-17 08:10:30 +01:00
quick-start.md Update doc/manual/src/quick-start.md 2023-02-19 20:00:02 -05:00
SUMMARY.md.in document the store concept (#9206) 2023-10-25 02:28:35 +00:00