Documentation: How Blink works

[Kentaro Hara]

Hi

TL;DR: I wrote "How Blink works".

Five months ago Jeremy conducted a survey about Blink's code complexity and identified that lack of documentation is a huge concern.

As an effort to improve documentation, I tried to write "How Blink works". I hope that it will help new Blink developers get familiar with the high-level design of Blink's architecture.

"How Blink works" also identified a bunch of key documents missing in the code base (e.g., HowToUseWTF.md, HowToUsePostTask.md, ThreadProgrammingInBlink.md). I'm trying to assign owners to those documents and get them ready soon :)

Any comments / feedback is welcome!

--

Kentaro Hara, Tokyo, Japan

[Yoav Weiss]

Thank you so much for writing this! This seems very helpful to get new contributors started :)

--
You received this message because you are subscribed to the Google Groups "blink-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to blink-dev+...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/blink-dev/CABg10jxAjafb6-3YKyxX3nb8Gbgt0xM_orhHccbUT1m320Q3SQ%40mail.gmail.com.

[Steve Kobes]

This is a great document!

We should perhaps link to it from third_party/blink/README.md.

I have also added it to www.chromium.org/blink#TOC-Developing-Blink and dev.chromium.org/developers/design-documents.

--
You received this message because you are subscribed to the Google Groups "platform-architecture-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an email to platform-architecture-dev+unsub...@chromium.org.
To post to this group, send email to platform-architecture-dev@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/platform-architecture-dev/CABg10jxAjafb6-3YKyxX3nb8Gbgt0xM_orhHccbUT1m320Q3SQ%40mail.gmail.com.

[Chris Palmer]

Thanks for writing this, Kentaro. :)

[Nico Weber]

Looks great!

Should this be a checked-in README.md in third_party/blink instead of a docs link? There are a few diagrams, but they can probably be ascii instead (http://asciiflow.com/ etcc).

On Tue, Aug 14, 2018 at 5:56 PM Chris Palmer <pal...@chromium.org> wrote:

Thanks for writing this, Kentaro. :)

--

You received this message because you are subscribed to the Google Groups "platform-architecture-dev" group.

To unsubscribe from this group and stop receiving emails from it, send an email to platform-architect...@chromium.org.
To post to this group, send email to platform-arc...@chromium.org.
To view this discussion on the web visit https://groups.google.com/a/chromium.org/d/msgid/platform-architecture-dev/CAOuvq22DmhJbnbw5RTH6gK%2BAz6intT2bBQRdoJC7Wc9-BTqjZQ%40mail.gmail.com.

[Kentaro Hara]

I added the link of the doc to blink/renderer/README.md.

For now I want to keep it in Google's Doc since comments from people are really useful to polish up the descriptions :)