Skip to content
This repository has been archived by the owner on Feb 27, 2024. It is now read-only.

Commit

Permalink
move chapter structure to introduction
Browse files Browse the repository at this point in the history
  • Loading branch information
fricklerhandwerk committed May 25, 2022
1 parent e706fda commit 49e160d
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 32 deletions.
30 changes: 2 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,36 +4,10 @@ This community online learning resource — not a book in the conventional sense

It shall offer a centralized autodidactic onboarding path into Nix and its surrounding ecosystem.

## Structure

The book is supposed to fit between first impressions on the [Nix web site][nixos-org] and the reference manuals for [Nix][nix-manual], [Nixpkgs][nixpkgs-manual], [NixOS][nixos-manual].

It is oriented around use cases:

- What can you do with Nix?
- How easy is it?
- Some things are trivial and fun.
- Some things require disciplined learning to get productive.
- Some things do not work properly, have confusing interfaces, or inadequate documentation.

- How to do it?

Depending on how well a use case is supported, we can provide
- instructions and examples
- links to known-good external resources, with summaries
- overview of available tools, and their state of maturity and maintenance
- overview of ideas, and state of community discussion.

- How to continue from here?

Depending on how well a use case is explored, we can link to
- other chapters
- reference manuals
- external projects
- ongoing community discussion.

## A vision for the journey into Nix, `nixpkgs`, and NixOS

This book is supposed to fit between first impressions on the [Nix web site][nixos-org] and the reference manuals for [Nix][nix-manual], [Nixpkgs][nixpkgs-manual], [NixOS][nixos-manual].

```mermaid
flowchart
subgraph homepage
Expand Down
41 changes: 37 additions & 4 deletions contents/README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,45 @@
# Outline

The book shall be organized top-down from defining a problem domain, the solution approach Nix takes, following explanations how solutions for each specific problems are designed. Each section shall have working examples how to use the presented solution and links to relevant reference manuals.
## How to read this book

Each section should have an interactive questionnaire to (at least shallowly) determine learning success and collect feedback.
Each section has the following structure:

Sections are ordered from generic to specific. Sections depend on insights from previous chapters, and these dependencies should be made clear, already in the process of developing the book, to further inform a suitable structure or reading order.
- What will you learn? (problem statement and learning goals)
- What do you need? (prerequisites)
- Previous chapters
- Domain-specific skills or knowledge
- How easy is it? (level of difficulcy)
- Some things are trivial and fun.
- Some things require disciplined learning to get productive.
- Some things do not work properly, have confusing interfaces, or inadequate documentation.

- How to do it? (instructions)

Depending on how well a use case is supported, we can provide
- instructions and examples
- links to known-good external resources, with summaries
- overview of available tools, and their state of maturity and maintenance
- overview of ideas, and state of community discussion.

- What did you learn? (assessment)

To further improve the book, the tools and their documentation, we assess your learning success.
You can also ask questions, and leave feedback or suggestions.

- (optional) How does it work? (explanation)

For the curious: a brief explanation of the mechanism behind the solution Nix offers.

- How to continue from here? (next steps)

Depending on how well a use case is explored, you can proceed to
- other chapters
- reference manuals
- external projects
- ongoing community discussion.

Chapters and sections are ordered by increasing level of difficulcy.

Software developers building their own projects may take a different path than end-users who just want to use packaged software temporarily or persistently.

## Which problems Nix solves

Expand Down

0 comments on commit 49e160d

Please sign in to comment.