haskell / haskell-ide-engine

The engine for haskell ide-integration. Not an IDE
BSD 3-Clause "New" or "Revised" License
2.38k stars 211 forks source link

Document architecture #596

Closed lukel97 closed 6 years ago

lukel97 commented 6 years ago

We should make a diagram for the process and message flow internally. This will also make it easier to find and identify points to write tests for.

Reading

https://www.yesodweb.com/blog/2015/08/thoughts-on-documentation http://www.mcternan.me.uk/mscgen/ https://en.wikipedia.org/wiki/Message_Sequence_Chart https://github.com/haskell/haskell-ide-engine/pull/495 https://www.websequencediagrams.com/

alanz commented 6 years ago

Perhaps consider some of https://gist.github.com/rodneyrehm/40e7946c0cff68a31cea