Idea : markdown + code → new take on literate programming
https://rethinkingsoftware.substack.com/p/organic-markdown-intro
Best practices for language / standard library docs
https://walnut356.github.io/posts/language-documentation/
https://news.ycombinator.com/item?id=41525987
-
Where should someone new to the codebase start? Literally, which line in which file?
-
How does the code “fit together”? What is the call-graph of its top use-cases?
-
What are its compile-time and run-time dependencies? Which exact versions of those dependencies were used during development?
-
When something isn’t working, how can someone replicate your development environment EXACTLY in order to determine what’s different about theirs?
-
How would you approach debugging on this codebase? A detailed write-up or even a video of every step you took could help someone new gain a deep understanding quickly.