-
-
Notifications
You must be signed in to change notification settings - Fork 258
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
fix up language in the packaging tutorial #887
fix up language in the packaging tutorial #887
Conversation
fricklerhandwerk
commented
Jan 28, 2024
- make many sentences shorter
- add links
- expand on finding things
- use more domain-specific headings
- add next steps
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't complete all the way down - thank you for putting in this work @fricklerhandwerk ! ❤️
- make many sentences shorter - add links - expand on finding things - use more domain-specific headings - add next steps
Co-authored-by: Henrik <i97henka@gmail.com>
Co-authored-by: Henrik <i97henka@gmail.com>
daa1e02
to
fdc012f
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I went through the first half of the changes, and will try to get to the second half in a few hours.
As is, this PR greatly improves the readability of the tutorial, so please feel free to ignore any comments that are too nit-picky!
@@ -179,7 +214,7 @@ building | |||
Great news: the derivation built successfully! | |||
|
|||
The console output shows that `configure` was called, which produced a `Makefile` that was then used to build the project. | |||
It wasn't necessary to write any build instructions in this case because the `stdenv` build system is based on `autoconf`, which automatically detected the structure of the project directory. | |||
It wasn't necessary to write any build instructions in this case because the `stdenv` build system is based on [GNU Autoconf](https://www.gnu.org/software/autoconf/), which automatically detected the structure of the project directory. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this sentence implies autoconf
itself detected the structure of the project, which is incorrect.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What would you suggest here?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looking good, left some minor suggestions
Co-authored-by: Olivia Crain <olivia@olivia.dev>
43517fb
to
48c62b8
Compare
Thanks a lot @oliviacrain for the great, diligent review comments! I think we can leave the last one for now and fix it later. |