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

Improve docs #2545

Closed
davidacevedo opened this issue Jun 8, 2022 · 3 comments
Closed

Improve docs #2545

davidacevedo opened this issue Jun 8, 2022 · 3 comments

Comments

@davidacevedo
Copy link
Collaborator

davidacevedo commented Jun 8, 2022

Adding more text content to the docs to make it look more like the Bootstrap documentation might make it easier to use the documentation. Currently, we have examples in stories, with almost zero text and I think adding text might make things better.

For example the accordion flush page for Reactstrap doesn't say anything. I was thinking of taking the text from Bootstrap accordion flush and adding to it to look something like the following:

Add flush prop to remove the default background-color, some borders, and some rounded corners to render accordions edge-to-edge with their parent container.

This would make it easier for users to use Reactstrap without referring to the bootstrap docs. Let me know your thoughts.

Originally posted by @illiteratewriter in #2509 (comment)

illiteratewriter added a commit to illiteratewriter/reactstrap that referenced this issue Jun 8, 2022
illiteratewriter added a commit to illiteratewriter/reactstrap that referenced this issue Jun 8, 2022
davidacevedo pushed a commit to illiteratewriter/reactstrap that referenced this issue Jun 8, 2022
@davidacevedo davidacevedo changed the title Adding more text content to the docs to make it look more like the Bootstrap documentation might make it easier to use the documentation. Currently, we have examples in stories, with almost zero text and I think adding text might make things better. Improve docs for spinner Jun 8, 2022
@illiteratewriter illiteratewriter changed the title Improve docs for spinner Improve docs Jun 10, 2022
@phoneticallySAARTHaK
Copy link

The sidebar is kinda weird in mobile as well... takes too much space

preview.mp4

(notice the clicks, it doesn't auto-hide)

@illiteratewriter
Copy link
Member

@phoneticallySAARTHaK This is more of an issue with Storybook rather than with Reactstrap

illiteratewriter added a commit to illiteratewriter/reactstrap that referenced this issue Jun 16, 2022
@phoneticallySAARTHaK
Copy link

phoneticallySAARTHaK commented Jun 16, 2022

@phoneticallySAARTHaK This is more of an issue with Storybook rather than with Reactstrap

I realise. Still, Reactstrap is UI framework. It wouldn't feel right if their own docs website had silly bugs.

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

No branches or pull requests

3 participants