How to help with the documentation about tachyons

[notenociz]

I feel that the docs are nice and simple as they are though I would expect that a more detailed and exhaustive approach would benefit some.

If the @mrmrs was to decide on a detailed approach, I would recommend that he do what @jxnblk did with basscss and cover all or almost all possible options with the specific module.

For example, the doc for btn shows input, button and a (anchor) elements using the btn class.

However, I am unsure whether this applies to Tachyons as Basscss does have some basic styles in it which make documenting easier while for Tachyons, you would have to do all the individual classes required to make the element style in an aesthetically pleasing way as Tachyons doesn't have default styling for any elements without requiring classes (this is for a good reason imo).

[mrmrs]

@mrzmyr don't know if I really follow you here. What does a better insight of the modules first mean? What would a complete module overview look like?

[mrzmyr]

What I mean is the initial effort to discover.

A lot frameworks out there try make the effort of reading stuff as small as possible. Including code and explanations, or at least make them optional and intuitive to use.

• They give a overview about all components in the same viewport. (by their sidebars)
• They make looking at the actual code behind optional. (just the usage is important)

Some examples:

• Clank Buttons
• Ionic Buttons
• Bass CSS Buttons

[mrmrs]

@mrzmyr there will be far too many components to have a complete overview similar to these examples. The site nav hasn't really been fleshed out as other things have taken higher priority. In some ways tachyons is just a css api that is limited to a cohesive design system. It's a pretty vast undertaking that can't be quickly undertaken. Docs need to cover several aspects from design principles, architecture methodology, as well as several tiers of components. I'm confused as to the title of this issue and the direction you have taken the conversation.

[mrzmyr]

I'm just trying to share my concerns with the current docs, in mind, to may solve them with the next docs update.

Whats your idea of the next version of the docs?

[mrmrs]

It's not really a 'next version' - I just started in on these docs. Still lots of improvements to make. We're splitting out the documentation to be more automated and more agnostic. Just be patient. Until last week it was just me developing this - and now it is just two people. Both with full time jobs.

[mrmrs]

Closing this out as the thread has been dead for a while.