aboutsummaryrefslogtreecommitdiff
path: root/doc/manual/src/architecture/architecture.md
AgeCommit message (Collapse)Author
2024-05-05Fix the pages in the manual for LixJade Lovelace
This doesn't comprehensively fix everything outdated in the manual, or make the manual greatly better, but it does note down where at least jade noticed it was wrong, and it does fix all the instances of referencing Nix to conform to the style guide to the best of our ability. A lot of things have been commented out for being wrong, and there are three types of FIXME introduced: - FIXME(Lix): generically Lix needs to fix it - FIXME(Qyriad): re https://git.lix.systems/lix-project/lix/issues/215 - FIXME(meson): docs got outdated by meson changes and need rewriting I did fix a bunch of it that I could, but there could certainly be mistakes and this is definitely just an incremental improvement. Fixes: https://git.lix.systems/lix-project/lix/issues/266 Change-Id: I5993c4603d7f026a887089fce77db08394362135
2024-03-29Add `pre-commit` checksRebecca Turner
The big ones here are `trim-trailing-whitespace` and `end-of-file-fixer` (which makes sure that every file ends with exactly one newline character). Change-Id: Idca73b640883188f068f9903e013cf0d82aa1123
2023-06-17Fix wikipedia links (#8533)Christina Sørensen
2023-01-10doc/manual: Fix broken internal linksRobert Hensing
The targets I could find.
2022-12-20add more explanation to diagramsValentin Gagarin
this is to help reading the diagrams, otherwise arrows and labels were reported as being ambiguous.
2022-12-12suggestions from reviewValentin Gagarin
2022-11-09remove external linkValentin Gagarin
the language has its own overview page where its properties are described in sufficient detail.
2022-11-09make diagrams compatible with svgbobValentin Gagarin
this will at some point enable rendering them nicely for the web
2022-11-09clarify subject of sentenceValentin Gagarin
Co-authored-by: Bryan Honof <bryan.honof@tweag.io>
2022-11-09add articlesValentin Gagarin
2022-11-09manual: architecture overviewValentin Gagarin
these changes were not merged properly and had to be reverted. see merge commit d8e54d19f71f78540dd967b2e42be6a5d8a0b1bb for full history leading up to here.
2022-08-22Revert "Merge pull request #6420 from nix-community/doc-what-is-nix"Valentin Gagarin
This reverts commit 81e101345fda2a8651c470f08b364a1ca6fa37cf, reversing changes made to 7d1280bbaf7f4cd142c2259dec620c42bf6f96fd.
2022-08-04Add disclaimer that arch section is WIP and links may rotJohn Ericson
So we can iterate without worrying so much.
2022-08-04use correct mdBook syntax for calloutsValentin Gagarin
2022-08-04use "build plan" consistentlyValentin Gagarin
2022-08-04introduce mapping to Unix files and processesValentin Gagarin
2022-08-04introduce build tasksValentin Gagarin
while it appears a bit much for the overview, this way we set the stage for going directly into data types when describing the store, instead of first having to say what build tasks are and how they relate to build plans.
2022-08-04revert to build plans in top-level overviewValentin Gagarin
do not introduce build tasks yet, that is the next level of detail.
2022-08-04use reference links for URLsValentin Gagarin
2022-08-04revert to "build plan" in overview diagramValentin Gagarin
this displays correct composition again. build inputs and build results are not part of build plans in terms of data objects. also this is a much less complicated setup. this will be the first impression of architecture, and we want to get it right.
2022-08-04Nix store does not underly literally everythingValentin Gagarin
Co-authored-by: Robert Hensing <roberth@users.noreply.github.com>
2022-08-04add link from overview to store sectionValentin Gagarin
the overview should only link to the three main concepts presented. the store is now fairly fleshed out. others can follow later.
2022-08-04architecture overview: add link to command line referenceValentin Gagarin
2022-08-04architecture overview: add link to Nix expression language referenceValentin Gagarin
update summary title to match file contents
2022-08-04clarify relation of tasks and plansValentin Gagarin
2022-08-04build rule -> build taskValentin Gagarin
closer to "build systems a la carte", satisfies all other complaints
2022-08-04build step -> build ruleValentin Gagarin
"step" sounds atomic, while "rule" hints at internal structure, which in our case consists of mapping inputs to outputs using build instructions.
2022-08-04match grammatical case to arrow directionValentin Gagarin
2022-08-04update architecture diagramValentin Gagarin
2022-08-04reword introduction to rosetta stone, add linksValentin Gagarin
attempt to explain used and documented terminology, as well as how the declarative programming paradigm relates to building software. in the future one could highlight encouraged terms to shape future material into higher consistency.
2022-08-04design -> architecture, add motivationValentin Gagarin
following ideas found in Architecture of Gazelle[1] [1]: https://github.com/bazelbuild/bazel-gazelle/blob/56d35f8db086bb65ef876f96f7baa7b71516daf8/Design.rst