-
Notifications
You must be signed in to change notification settings - Fork 14
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
chore(docs): Add first version of architecture doc #697
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great.
We have some nomenclature problems, as usual, ehe.
There is a reference to a Broadcast
effect that I could not find in the referred source file.
I wonder whether this document should go into the |
Architecture.md can be seen as a prerequisite to anything that exists in docs/. |
I've fixed/renamed/updated all outstanding items. The only point I'd like to rehash is where the ARCHITECTURE.md resides. I would still put it in the docs folder because, at one point, we will publish the docs as a website, and if everything is in one place, it makes the process much smoother. (Also, updating documentation is easier if everything is in one place.) We could leave a placeholder ARCHITECTURE.md in the root folder, pointing to the one in the docs folder. At least, that's my 2 cents. |
Co-authored-by: Romain Ruetschi <[email protected]>
Co-authored-by: Romain Ruetschi <[email protected]>
Co-authored-by: Romain Ruetschi <[email protected]>
I have no particular opinions where architecture.md should sit between top-level and within docs/. Both are fine. If no one takes a decision/merges by tmrw morning (CET), I'll go ahead and leave as it (at top level) and merge this. |
Let's put it in |
Nevermind, let's leave it where it is, nice to have at the top-level. |
Part of #375
PR author checklist