| ▲ | chairhairair 6 days ago | ||||||||||||||||||||||||||||||||||
A company (mutable ai) was acquired by Google last year for essentially doing this but outputting a wiki instead of a tutorial. | |||||||||||||||||||||||||||||||||||
| ▲ | kaycebasques 4 days ago | parent | next [-] | ||||||||||||||||||||||||||||||||||
I meant to write a blog post about mutable.ai but didn't get around to it before the product shut down. I did however archive the wiki that it generated for the project I work on: https://web.archive.org/web/20240815184418/wiki.mutable.ai/g... (The images aren't working. I believe those were auto-generated class inheritance or dependency diagrams.) * The first paragraph is pretty good. * The second paragraph is incorrect to call pw_rpc the "core" of Pigweed. That implies that you must always use pw_rpc and that all other modules depend on it, which is not true. * The subsequent descriptions of modules all seemed decent, IIRC. * The big issue is that the wiki is just a grab bag summary of different parts of the codebase. It doesn't feel coherent. And it doesn't mention the other 100+ modules that the Pigweed codebase contains. When working on a big codebase, I imagine that tools like mutable.ai and Pocket Flow will need specific instruction on what aspects of the codebase to document. | |||||||||||||||||||||||||||||||||||
| ▲ | zh2408 6 days ago | parent | prev [-] | ||||||||||||||||||||||||||||||||||
Their site seems to be down. I can't find their results. | |||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||