Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

BRC documentation improvement #1416

Open
marcopiii opened this issue Jan 16, 2020 · 2 comments
Open

BRC documentation improvement #1416

marcopiii opened this issue Jan 16, 2020 · 2 comments
Assignees
Labels

Comments

@marcopiii
Copy link
Member

marcopiii commented Jan 16, 2020

I'm finding several issues in the documentation of BRC. I'm going to list all the ones I find here.

  1. Part of the documentazione is scritta in italian and parte in english 🤨

  2. 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.

  3. 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.

  4. The Design Guidelines tab of lots of components just contains a replica of the props & methods grid.

  5. A favicon may increase the coolness of BRC suite by 42% (this may not be based on actual data).

Button

  1. 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.

  2. In the Button size paragraph the small and medium buttons look equals.

  3. The Type of buttons paragraph the icon button example has no icon.

Form

  1. All the images in the Design Guidelines tab are missing (broken URL)

LoadingSpinner

  1. 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

  1. 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.

  2. The Styled components snippet gives error

Dropdown

  1. The panel with documentation about props & methods is completely missing
@marcopiii marcopiii changed the title Button doc improvement BRC documentation improvement Jan 28, 2020
@ggallace
Copy link

ggallace commented Mar 6, 2020

Come logica, suggerirei di fixare le parti che non richiedono analisi di usabilità o tempo eccessivo per risolvere.

Distinguerei anche improvements/bugs e design/contenuto

@alessandravilla e @giogonzo valutate voi quale portare avanti

@giogonzo
Copy link
Member

giogonzo commented Mar 6, 2020

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?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

4 participants