Open patrick-gu opened 1 month ago
Things that should be considered:
it's fine that we're not in a state of 100% completion. Continuous documentation is arguably more valuable than just spitting out a thing at the end.
Other things that should be considered:
It would be good to have a document that just describes the parts of what we're doing, and how it all fits together at a high level. Personally, I think just having a markdown document with textual information should be fine. Diagrams would be hard to maintain and would not bring enough value to justify the time.
I'm not sure if we're in a state where it's really worth it to write documentation yet, since we might have to reevaluate our methods. Maybe we could write a brief document right now though.
@celery6