Documentation is poor

The documentation is pretty poor guys…

Expected Behavior

I should be able to read through the Documentation and learn how everything works without wanting to hit my head on the wall

Actual Behavior

I read through incomplete samples that are poorly rendered and don’t describe pretty basic use-cases

URL, screen shot, or Codepen exhibiting the issue

A few samples…

You guys realize that you can specify borders for any of the four sides (in any combination) of a block-level element in CSS, right? How might I specify borders for top, left, and right but not bottom? Not clear…

From https://v2.grommet.io/box

What is with the “count” value when you specify an object for columns? Can you specify a number here or is it just “fit” or “fill”? Why would you call this property “count”? Further, did you know that when you try to use the areas property in conjunction with specifying an object for the columns property that you get an error? Why is that not written anywhere?

From https://v2.grommet.io/grid

What exactly is going on here? You expect me to want to use your library when you clearly have rendering issues?

https://v2.grommet.io/datatable

Steps to Reproduce

Visit the links I provided and see for yourself

Your Environment

I’m on Windows 10/Chrome

[alansouzati]

Thanks for reporting this. We will look into fixing these issues. We recognize our site has its limitations and bugs. Just don’t let that prevent you from trying and engaging with us. I think Grommet is far from being perfect, but we appreciate contributions from the community. You seem to know what you are talking about so yeah please contribute to make it better. This is the right open source mentality.

[ShimiSun]

Box - multiple borders is a valid enhancement

Grid - on https://v2.grommet.io/grid? there is a built-in example of using areas with column object and I wasn’t able to reproduce the error in the description, feel free to share more information on the GRid you used that reproduced the error, we do need to document it if it still exists.

Datatable - The Datatable layout problem on the grommet-site is fixed.

Reviewing this issue, the multiple border enhancement request was implemented during Hacktoberfest I believe, see the updated docs https://v2.grommet.io/box#border

The other errors and warnings are fixed and no longer reproducible.

The last issue raised on the documentation of Datatable border has a fix on #2475

Thank you for reporting this issue, we came a long way with our documentation since v2 was released, and we are continuing to look for ways to improve. I’ll be closing this issue, but feel free to file any new issues that can help us improve.