Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Structural: Start the language section earlier #194

Open
hsjobeki opened this issue Jun 4, 2022 · 1 comment
Open

Structural: Start the language section earlier #194

hsjobeki opened this issue Jun 4, 2022 · 1 comment

Comments

@hsjobeki
Copy link

hsjobeki commented Jun 4, 2022

Could it be possible to improve the structure of the documentation. As a reader it is not obvious how to start and what topics are needed to learn first.

I suggest the following structure:

  1. short! Introduction
  2. nix language (it is necessary)
  3. nix principles ….

Thanks in advance

@jtojnar
Copy link
Member

jtojnar commented Jun 4, 2022

As mentioned in the preface, the pills originated as a series of blog posts and are meant to be read in order.

I would say that the language description already starts as soon as possible (pills 4 & 5):

  • Pill 1 is an introduction + principles.
  • Pill 2 is how to get Nix on your system, which you will need for playing with the language.
  • Pill 3 is what you will need to know for working with packages/derivations. And since Nix pills introduce Nix through building derivations from scratch, that is necessary too.

I guess it would be possible to move pill 3 after pill 5, since they are largely independent but I think having a chapter where the reader can do something in between learning-heavy chapters is beneficial.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants