aengl / cocoon-demo Goto Github PK

1. Why is there nothing displayed on the graph when I choose any combination other than the default?

2. Why does the preview change every time I click on the MapValues node?

You already explained, but I think we might want to add an explanation. The reason was: all preview views will sample the data so it doesn't affect performance

3. Why is y the only dimension that has ' ' attached?

4. Almost missed the fact that there was a readme available for the simple-api example. At least for the first example, maybe we should add a link to it in the main readme. It also took me a bit to realize I get a tooltip on mouseover.

I think I'll suggest adding a separate node under the first one that only does documentation, and describes exactly this: Text underneath Hover a node to get a snippet of what it does. Text on hover Check out the readme for this demo at blablabla/readme.html

I could easily create a PR for all of this, but documenting stuff in this issue might be useful for that as well. Plus, maybe you should have a look and tell me what you think before I create a PR for all of this. 🤔 Some of it is nitpicking 😊

• 1. I find the introduction text a bit dry. Let's see if we can reword it to sound a bit more approachable

• 2. The spacing between the text and subsequent images makes it hard to figure out which of the images you're referring to. The one on the top, or the one on the bottom?

• 3.

• 4.

• 5. Avoid impersonal sentences. 🤔At least I think there was something about this in the google copy (text on UI and services) guidelines https://material.io/design/communication/writing.html#

• 6. Rename -demo into -docs? I think this is the most arguable (and personal oppinion) point in this issue. See explanation on screenshot and feel free to argue 😁

• 7. The custom-nodes example explains a lot more than what the name implies. We should at least list everything we're talking about in the main readme, so I don't have to keep a reference to the specific example to know how to get back to it.

Following the example custom-nodes