You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
It would be great to have a very consistent color and style for links within docs. Color coding of different things - is great, but without consistency it is harder to get quickly familiar with things.
Code syntax highlight should match the color schema of the docs or vice-versa.
Use color only for meaningful color coding, and reserve a distinct color per type of element we want to highlight. E.g. Class should use the color that others don't use. And class should be everywhere highlighted with such color (lists, links, code examples, syntax highlight, etc).
Links
If anything is clickable, it should look as clickable, and other elements should not use same way of highlighting to avoid confusion.
Obvious navigation lists, e.g. list of properties, accessors, methods - do not require underlines.
Subtle underline can help with that:
Currently:
With underline:
Classes
For example, all classes are colored cyan:
But clickable links are all different colors:
Functions
Functions are purple:
But in docs it shows methods as Pink:
And then goes back to purple below for these methods:
But in syntax highlight we switch to yellow:
Properties and Accessors
In engine they are very close, in some rare cases it is worth to know distinction, but generally engine uses them interchangeably, without providing any meaningful difference to the user. End of the day accessors do behave like properties.
Biggest thing, is that list of properties and accessors - is a public API, and the splits into two separate blocks does not provide meaning, but makes it harder to overview.
Also they don't need to look different as they behave by the end user the same.
Obvious examples would be: Entity.path and Entity.name. But even everything else. It is confusing distinction in general for API overview:
The text was updated successfully, but these errors were encountered:
It would be great to have a very consistent color and style for links within docs. Color coding of different things - is great, but without consistency it is harder to get quickly familiar with things.
Code syntax highlight should match the color schema of the docs or vice-versa.
Use color only for meaningful color coding, and reserve a distinct color per type of element we want to highlight. E.g. Class should use the color that others don't use. And class should be everywhere highlighted with such color (lists, links, code examples, syntax highlight, etc).
Links
If anything is clickable, it should look as clickable, and other elements should not use same way of highlighting to avoid confusion.
Obvious navigation lists, e.g. list of properties, accessors, methods - do not require underlines.
Subtle underline can help with that:
Currently:
With underline:
Classes
For example, all classes are colored cyan:
But clickable links are all different colors:
Functions
Functions are purple:
But in docs it shows methods as Pink:
And then goes back to purple below for these methods:
But in syntax highlight we switch to yellow:
Properties and Accessors
In engine they are very close, in some rare cases it is worth to know distinction, but generally engine uses them interchangeably, without providing any meaningful difference to the user. End of the day accessors do behave like properties.
Biggest thing, is that list of properties and accessors - is a public API, and the splits into two separate blocks does not provide meaning, but makes it harder to overview.
Also they don't need to look different as they behave by the end user the same.
Obvious examples would be: Entity.path and Entity.name. But even everything else. It is confusing distinction in general for API overview:
The text was updated successfully, but these errors were encountered: