BUG: Spacing in examples across the documentation

[krau5]

Description

The documentation includes many components, each with its own usage example. However, several components have spacing issues in their examples. Additionally, there are occasional questionable code decisions (e.g., why include a Kbd example within the Progress component example?).

We should also standardize the examples to follow a consistent "style." For instance, the Callout and Kbd examples differ significantly: first only includes code, while the second wraps the example in a "component" (i.e., not just JSX).

Example

Examples should be consistent. Examples should have consistent spacing.

[kotAPI]

Totally agreed! Most of the examples you see here haven't been updated in over a year!
Moreover, the code is hardcoded in the docs and isn't the rendered example that's shown in the docs. We'll have to solve that issue first - where the code you see is the code that gets rendered in the demo.

I haven't been paying much attention to the docs development side as I was fully focussed on studying and adding more components and improving their stability

[krau5]

We'll have to solve that issue first - where the code you see is the code that gets rendered in the demo.

I am not that familiar with the codebase yet, but imo it might be much harder to implement. It's easier to update hardcoded examples and then it'd be nice to take care of the issue you've specified

[kotAPI]

I am not that familiar with the codebase yet, but imo it might be much harder to implement. It's easier to update hardcoded examples and then it'd be nice to take care of the issue you've specified

True, we can definitely get back to this once we stabilize and get the components ready for production, we can park this issue for a while maybe?

Once we have good number of components built, it will aid us building better documentation interfaces too!

[krau5]

Once we have good number of components built, it will aid us building better documentation interfaces too!

Well 😅 Yes and no. Building new components is definitely good, but the code we have should be documented (and tested) as well. It is better to have 10 production-ready components with tests and good documentation, than 100 components without docs and tests, but with a good amount of errors

[kotAPI]

Once we have good number of components built, it will aid us building better documentation interfaces too!

Well 😅 Yes and no. Building new components is definitely good, but the code we have should be documented (and tested) as well. It is better to have 10 production-ready components with tests and good documentation, than 100 components without docs and tests, but with a good amount of errors

Well, sure!
I use this library in my projects, I thought I'll release it to public once there are about 40+ components. Completing this list was the goal - #115.

Contributors come and go and I've been mostly working on this alone without an accountability buddy, so this list was my guide. If you have the time and interest to work towards making the documentation and its components production ready, I wouldn't say no. I'm ready to help you with whatever you need.