Skip to content
This repository has been archived by the owner on Oct 7, 2020. It is now read-only.

Document architecture #596

Closed
lukel97 opened this issue May 25, 2018 · 1 comment · Fixed by #631
Closed

Document architecture #596

lukel97 opened this issue May 25, 2018 · 1 comment · Fixed by #631
Labels
component: documentation
Milestone
prehistory

Comments

@lukel97
Copy link
Collaborator

lukel97 commented May 25, 2018

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
#495
https://www.websequencediagrams.com/
@alanz
Copy link
Collaborator

alanz commented May 25, 2018

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

lukel97 added a commit to lukel97/haskell-ide-engine that referenced this issue May 31, 2018
@lukel97
Document dispatch
8dc1c87 
Begin documenting the new architecture. Addresses haskell#596
@lukel97 lukel97 mentioned this issue May 31, 2018
Merged
@lukel97 lukel97 mentioned this issue Jun 14, 2018
Merged
@alanz alanz added this to the prehistory milestone Feb 2, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees
No one assigned
Labels
component: documentation
Projects
None yet
Milestone
prehistory
Development

Successfully merging a pull request may close this issue.

Update some documentation lukel97/haskell-ide-engine
3 participants
@alanz @Anrock @lukel97