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

StructureChange-chapter1 #32

Open
wants to merge 13 commits into
base: restructure-book
Choose a base branch
from
Open

Conversation

tshiya731
Copy link
Collaborator

Hi Robert, in this PR i made some changes about the structure of Chapter1:

  1. Changed the github file name as is suggested Book/name.md and Book/name/subpages/..
  2. Changed the structures
  3. I added the overview page (01/01.md), however, I am not sure should I write something down or just leave it to you.
    @rlanzafame

@tshiya731 tshiya731 requested a review from rlanzafame January 31, 2025 21:49
@tshiya731
Copy link
Collaborator Author

Hi, Robert, the changes made are as follows:

  1. I rearranged small exercises and remained the large exercises (long description+code) in the original place.
  2. Deleted the moved exercises from the original place.
  3. I remained the (manually) numbering in markdown cells, but it wont show in the online notebook. So we can still track the original numbering of exercises.

@rlanzafame

@rlanzafame rlanzafame changed the base branch from main to restructure-book February 16, 2025 02:48
Copy link
Member

@rlanzafame rlanzafame left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, I think it's fine for now, just a couple requests:

  1. add any notes to quizzes
  2. can you check my notes about what you did in files ./docs/restructure.md? Add anything you think is missing
    Once this is done, we can merge the PR. Note that I made a new branch called restructure-book to collect all of the changes. This way you can start working with smaller PR's to keep track of things more easily (e.g., can start a new one for chapter 2, or chapter 1 nutshell).

@tshiya731
Copy link
Collaborator Author

@rlanzafame Hi Robert, I changed the nutshell in the commits. Are there something more to change for Chapter 1?

@rlanzafame
Copy link
Member

@rlanzafame Hi Robert, I changed the nutshell in the commits. Are there something more to change for Chapter 1?

Hi @tshiya731 it looks good! I just have a question about the section titles that show up in the right-hand table of contents for a specific page. There is not a 1-to-1 correspondence between the "theory" and "nutshell" versions. Do you think this is an advantage or disadvantage from a student perspective? I kind of like it as-is because it gives a different perspective on the same topics.

Take this page for example:

If you like it this way we can merge it. I will think about a nice way to provide links/buttons to jump between the theory and nutshell pages.

@tshiya731
Copy link
Collaborator Author

@rlanzafame Hi Robert, I changed the nutshell in the commits. Are there something more to change for Chapter 1?

Hi @tshiya731 it looks good! I just have a question about the section titles that show up in the right-hand table of contents for a specific page. There is not a 1-to-1 correspondence between the "theory" and "nutshell" versions. Do you think this is an advantage or disadvantage from a student perspective? I kind of like it as-is because it gives a different perspective on the same topics.

Take this page for example:

If you like it this way we can merge it. I will think about a nice way to provide links/buttons to jump between the theory and nutshell pages.

Hi @rlanzafame, sorry it took so long to reply as I just saw the message.
In my opinion, this difference, especially the numbering could be confusing for students. (For example, 1.2.4 and 1.2.5 in nutshell do not correspond to 1.2.4, 1.2.5 in theory). I think it's best to change the numbering, so students don't subconsciously assume they all correspond to each other. What do you think?

@tshiya731 tshiya731 requested a review from rlanzafame February 21, 2025 14:56
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