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
I'm finding several issues in the documentation of BRC. I'm going to list all the ones I find here.
Part of the documentazione is scritta in italian and parte in english 🤨
The documentation of every component starts with a copypaste-able example of its import, but the path of the module is never wrapped between single quotes, so it actually doesn't work and the user has always to fix it. Also, putting it in a darker background would make it more recognizable as a code snippet.
Right after the import example, most of components have a props & methods button that opens a table with all the details about its properties and methods. Unfortunately it has no layout around it and a font that makes it very hard to recognize it as a clickable element.
The Design Guidelines tab of lots of components just contains a replica of the props & methods grid.
A favicon may increase the coolness of BRC suite by 42% (this may not be based on actual data).
Button
The Button documentation has as very first example StatefulButton, which actually needs an import that is different from the described one (import { StatefulButton } from 'buildo-react-components/lib/Button';) and in the usage example uses an undocumented property baseState.
In the Button size paragraph the small and medium buttons look equals.
The Type of buttons paragraph the icon button example has no icon.
Form
All the images in the Design Guidelines tab are missing (broken URL)
LoadingSpinner
The guidelines say that "the dimmed layer should cover only the loading section" but by default it covers the whole screen. I think the documentation should provide some information to handle this.
Textarea Autosize
In the examples, all the textareas can be stretched way over theirs containers. This should not happen, and the guidelines may refer to this problem and how to avoid it.
The Styled components snippet gives error
Dropdown
The panel with documentation about props & methods is completely missing
The text was updated successfully, but these errors were encountered:
Come discusso offline con @Aslug , I believe some of the points above can be solved with low effort (0 effort di design). @Aslug could you try to list a few of the soluzioni possibili per i punti that seem easily actionable to you?
I'm finding several issues in the documentation of BRC. I'm going to list all the ones I find here.
Part of the documentazione is scritta in italian and parte in english 🤨
The documentation of every component starts with a copypaste-able example of its
import
, but the path of the module is never wrapped between single quotes, so it actually doesn't work and the user has always to fix it. Also, putting it in a darker background would make it more recognizable as a code snippet.Right after the import example, most of components have a props & methods button that opens a table with all the details about its properties and methods. Unfortunately it has no layout around it and a font that makes it very hard to recognize it as a clickable element.
The Design Guidelines tab of lots of components just contains a replica of the props & methods grid.
A favicon may increase the coolness of BRC suite by 42% (this may not be based on actual data).
Button
The
Button
documentation has as very first exampleStatefulButton
, which actually needs an import that is different from the described one (import { StatefulButton } from 'buildo-react-components/lib/Button';
) and in the usage example uses an undocumented propertybaseState
.In the Button size paragraph the
small
andmedium
buttons look equals.The Type of buttons paragraph the
icon
button example has no icon.Form
LoadingSpinner
Textarea Autosize
In the examples, all the textareas can be stretched way over theirs containers. This should not happen, and the guidelines may refer to this problem and how to avoid it.
The Styled components snippet gives error
Dropdown
The text was updated successfully, but these errors were encountered: