Skip to content

Allow a holistic view of the tutorial code (for Parts II and III) #117

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

Open
2 tasks
ISSOtm opened this issue Feb 14, 2025 · 3 comments
Open
2 tasks

Allow a holistic view of the tutorial code (for Parts II and III) #117

ISSOtm opened this issue Feb 14, 2025 · 3 comments

Comments

@ISSOtm
Copy link
Member

ISSOtm commented Feb 14, 2025

Some people have pointed out that Part II and Part III can be confusing with their “piecemeal” approach (sometimes people get confused as to what their code is supposed to look like after a given lesson, mostly). Having some way to show what the repo should look like at a given point in time would, I believe, solve issues like #110 too?

To do:

  • Figure out UX
  • Implement it
@hollannikas
Copy link
Contributor

Would it be enough for starters, to remove line numbe rhave a link to the code like this (possibly create a new file without anchors):

You can have a look at the completed source code here

And remove line number references from the tutorial texts.

@ISSOtm
Copy link
Member Author

ISSOtm commented May 1, 2025

Without the line number, how would you suggest one applies the mentioned changes?

@ISSOtm
Copy link
Member Author

ISSOtm commented May 1, 2025

I'd also like to mention that I have in mind to present those projects as proper Git repositories, and using libgit2 to extract the diffs and present those in the tutorial.

(We could have the source code be part of the tutorial repo as submodules, linking the projects together.)

This does require some engineering, but I think it would also make sense to present projects as, well, repos, since it's good practice for one's own projects to be structured that way. It'd be a good example.

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