nix-super/doc/manual
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
..
src document the store concept (#9206) 2023-10-25 02:28:35 +00:00
theme doc/manual: don't need to copy highlight.js manually 2021-08-04 19:47:05 -07:00
anchors.jq doc: Port anchors preprocessor to jq script 2022-05-26 18:17:21 +02:00
book.toml manual: Check links 2023-01-10 22:30:41 +01:00
custom.css disallow selecting shell prompt in code samples 2022-12-05 11:01:46 +01:00
generate-builtin-constants.nix revert anchor prefix for builtin constants 2023-07-20 10:27:38 +02:00
generate-builtins.nix Automatically document builtin constants 2023-06-27 09:37:54 -04:00
generate-manpage.nix Introduce MemoryInputAccessor and use it for corepkgs 2023-10-18 17:38:11 +02:00
generate-settings.nix accommodate inconsistent output from lowdown 2023-10-05 01:20:26 +02:00
generate-store-info.nix accommodate inconsistent output from lowdown 2023-10-05 01:20:26 +02:00
generate-xp-features-shortlist.nix Single page for experimental feature descriptions 2023-04-09 11:01:23 -04:00
generate-xp-features.nix Single page for experimental feature descriptions 2023-04-09 11:01:23 -04:00
local.mk Remove obsolete corepkgs references 2023-10-18 23:35:07 +02:00
quote-literals.xsl Generate release notes again 2014-03-12 14:24:29 +01:00
redirects.js AE -> BE; fix redirects 2023-10-09 10:07:46 +02:00
utils.nix always show anchors on setting listings 2023-10-05 00:05:08 +02:00