Per-page wording, misspellings, broken links, etc about old-documentation HOT 4 CLOSED

Thanks @nicosantangelo

I got up to "event handling" so far, I'm working on a separate branch for now

Some comments on what I've gone over so far:

• I'm not sure why the links you found are broken, the code looks fine but they don't work. I need to investigate
• "thru": yes it's less formal than through, but that's how we want to sound, we want the docs to have an approachable and friendly voice
• "speed up development times": although that might be a bit grammatically weird, it is a common way to say it
  -"Note:" : they are a bit redundant today, but we plan to have a more robust tool for publishing in the future that would distinguish comments with Note / Tip / Warning and show them in different colors.
  -"Next Step":Yeah, several of those don't make sense, that's something I need to revise well in the future
• MVP Guidelines: Yes, the reason why that article appears to be out of place is because it was written as something for the Districts and then we added it in here because there was no better place to publish it. Nevertheless, since it's in the "Building Scenes" section (not in the SDK Reference section), it's not all that bad. In the future we'll want to reshape this doc so that it's more useful.

from old-documentation.

I see that in some places in the docs what should be tag attributes are being called components:

Example:

 <box 
    rotation={currnetRotation}
    color={currnetColor}
    scale={currnetScale}
    transition={ 

Rotation component => Rotation attribute

Reference: https://docs.decentraland.org/sdk-reference/scene-content-guide/

from old-documentation.

@abarmat that's something we need to discuss, we need to have consistent terminology. It's difficult because there's a clash between multiple things:

• XML lens: those things are, as you say, attributes
• Entity / Component model lens: The tag ( "box" in your example) is an entity, and each of its attributes is a component. (https://en.wikipedia.org/wiki/Entity%E2%80%93component%E2%80%93system)
• React.js lens: the tag (the "box" in your example) is called a "component", not sure how the attributes would be called there, maybe "properties"?.

It's something I've been thinking about while I write, but I'm not very happy with how we're using these terms, we need to come up with terminology that fits all of these perspectives with the least amount of noise.

from old-documentation.

@nicosantangelo
Re: on "The The click event example shows that this.setState is a synchronous operation, this differs from React and confused me a bit. Should this be on a callback?"
this.setState is being run as part of a subscribeTo, which is an event handler that runs asynchronously.
I'm not all that familiar with React, so I'm not sure how it differs. How would you make that clearer for React users?

Re: on the what side to put Next Step vs Related Documents: agreed, we will soon start working with Mat on redesigning the docs page to enable several features we need. This should be amongst the requirements

Re: on the visual error on the screenshot:
I couldn't reproduce that, I tried zooming in and out of the page and couldn't get it to break. How did you get to see it like that?

Re: on "Sometimes it says export interface myState and others export interface IProps. The naming is kind of confusing"
The naming is different because they are two separate things. I use myState when declaring a scene state, and IProps when declaring the properties for a custom type of entity. State and properties are similar things, but they are meant to be used differently: the state for things that change locally, the properties for information that's inherited from parents.
On the other hand, most code samples outside the docs use IState rather than myState, and it would make sense to make it consistent with that, so I'll change myState to IState.

from old-documentation.