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

Teaching a new codebase #103

Open
joonas-fi opened this issue Sep 24, 2022 · 0 comments
Open

Teaching a new codebase #103

joonas-fi opened this issue Sep 24, 2022 · 0 comments

Comments

@joonas-fi
Copy link
Owner

Run program with the most important use cases, step through with a debugger automatically. Get a stack trace of the whole process. Exclude going into unimportant leaf nodes (maybe annotate things which should be kept in the walkthrough)

We could automatically make a video with panes:

  • Directory view (show file tree which file we're in)
  • Code view (show which code line we're on, even variable contents?)
  • Can even show map of previous functions and upcoming functions, like table of contents for the timeline

This all could be generated automatically and kept updated as the software evolves. You would just need to annotate the use cases.

A killer idea for teaching new people about the codebase.

https://mobile.twitter.com/DavidKPiano/status/1573261151311470593

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

No branches or pull requests

1 participant