Architecture (manual) merge into dev#1499
Conversation
Update architecture branch with latest dev
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
|
The new architecture diagram is still a WIP, mostly in miro, and some sketches I need to add to it. Will add in a future PR to dev. |
demiankatz
left a comment
There was a problem hiding this comment.
Thanks, @LlGC-jop, this is off to a good start. See below for minor suggestions and corrections. I confess that I was more focused on general organizational issues than the actual accuracy of the content, so apologies if I've missed the trees for the forest, as it were. ;-)
| Events are subscribed to by using uv.on("event", handler) , where uv is an instance returned by UV.init("id", data) . See this example in the embed HTML. | ||
|
|
||
| <!-- omit in toc --> | ||
| ### CONFIGURE |
There was a problem hiding this comment.
Should these events be one heading level deeper than "Descriptions" or are they meant to be at the same level?
There was a problem hiding this comment.
I'm not sure what the intent was, I think I must have copied everything from Geoff's document I think?
Either way, I'll make a bulleted intro summary to match the formatting in other docs, so it's consistent.
There was a problem hiding this comment.
Something weird is going on, because the CONFIGURE event is indented at a different level from all subsequent events. I can't see an obvious reason for this in the code, though!
There was a problem hiding this comment.
I wonder if making the TODO block above into another subheading/bulleted list will have any useful effect....
There was a problem hiding this comment.
I'll try copying the text into notepad and then back in. If I copied it from Google docs there might be some invisible formatting going on.
There was a problem hiding this comment.
It was the <object> part, must have confused the parser. Have made <> html entities.
…for clarity and to be an example.
demiankatz
left a comment
There was a problem hiding this comment.
Thanks, @LlGC-jop, I think this is in great shape and we should be able to merge it soon. I'd just like to see if we can figure out the unexpected behavior of the events outline first....
demiankatz
left a comment
There was a problem hiding this comment.
Excellent, the latest formatting fix seems to have sorted things out. I have no objection to merging this now -- it's a good foundation to continue building upon.
|
One suggested follow-up action: we should also link to the manual from the top-level README to make this more accessible. |
demiankatz
left a comment
There was a problem hiding this comment.
Thanks for the finishing touches, @LlGC-jop. Merging now!
Merges the architecture branch into dev so that the manual can be updated continuously as work on other issues takes place, or when and if someone has time to add to it.