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

Book intro chapters #54

Merged
merged 7 commits into from
Jan 23, 2024
Merged

Book intro chapters #54

merged 7 commits into from
Jan 23, 2024

Conversation

prrao87
Copy link
Member

@prrao87 prrao87 commented Jan 21, 2024

This PR adds the introduction piece's chapters to the book.

@sanders41 I'm leaning towards this general structure for each piece:

  • Create chapters within each piece's directory, with each chapter covering a core concept
  • This approach avoids cramming too much into one piece's written content, and avoids the reader having to "endlessly" scroll down to get to the end
  • Add a "Takeaways" header at the end of each chapter to help the reader summarize the key ideas from that chapter

I'll continue adding more chapters over the coming days. I just wanted to get some of the book's content going before I go back to writing some code again :)

@prrao87 prrao87 marked this pull request as draft January 21, 2024 03:42
@sanders41
Copy link
Collaborator

It looks like the idea is to create the topic under pieces, then put each major concept for that piece in its own md file. Is that right?

I pulled the branck down and ran it and I think it looks good this way. I can work on doing this with the pieces I put in after we get this one merged.

@prrao87
Copy link
Member Author

prrao87 commented Jan 21, 2024

Yup, the idea is to not rigidly break each piece into Python and Rust sections in the book, as the point of it is to illustrate the thought process and what can be learned from the piece of code. That's why I felt it made sense to compare and contrast each snippet of code (rather than dumping the whole file's code into a single markdown block).

The GitHub readme shows well enough how to work with the code, so I didn't go into the minutiae of how to run the code, what steps to follow, etc. But at the start of each piece, it makes sense to link to the subdirectory on GitHub so the reader can optionally look at the code rightaway.

@prrao87 prrao87 marked this pull request as ready for review January 23, 2024 04:34
@prrao87
Copy link
Member Author

prrao87 commented Jan 23, 2024

Merging the first 4 md pages to get the correct doc structure in place in main. Will continue to add more this week.

@prrao87 prrao87 merged commit 5928289 into main Jan 23, 2024
5 checks passed
@prrao87 prrao87 deleted the book-intro branch January 23, 2024 04:35
@prrao87 prrao87 restored the book-intro branch January 23, 2024 04:35
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

Successfully merging this pull request may close these issues.

2 participants