Need Proper Component Documentation for MDBootstrap React

web
mobile

Topic: Need Proper Component Documentation for MDBootstrap React

Sachith Rukshan asked 4 months ago

Expected behavior Atleast all the Main Components need to have a proper documentation

Actual behavior Found just two small app building tutorials. Which does not help.


Aliaksandr Andrasiuk staff answered 4 months ago

Hi,

Thank you for your response.

But what exactly you want to be improved? Which component's documentation didn't help you with the description of how to use it?

Maybe you can suggest what can be improved? It will be helpful for our team.


Sachith Rukshan commented 3 months ago

I actually was not able to find the documentation on website. After around 2 days of search only i found that hamburger menu icon on right top holds all the secrets. Ha ha. Better not hid it.


Aliaksandr Andrasiuk staff commented 3 months ago

Hi,

Thank you for the response! We will consider this.

Maybe you will be able to suggest something to improve our documentation? We will appreciate any ideas.


davidkjackson pro premium answered 3 months ago

I am currently looking at MDBootstrap with the view to getting the REACT Pro license.However, I am really struggling at trying to find any supporting documentation on each of the components and what all the parameters are for a given component. For example:where is MDBNavBar and every other MDBxxx..... component specifically documented along with the parameters that each component can use and what prerequisite components each might require to be in place. Seeing sample code that you can cut and paste doesn't help when it comes to wanting to see exactly what each component requires.


Aliaksandr Andrasiuk staff commented 3 months ago

Hi,

Probably our API tab doesn't noticeable. Every component's page has an API tab.

For example, Buttons: If you will look at the top of the page you will notice that near the Overview tab the page has API tab. There is the usage of all the properties and methods are described.

Also, some components have an additional tab Examples and customization : Card

If you have some other proposals for improving our documentation we are glad to listen to you.

Best regards.


Please insert min. 20 characters.
Status

Answered

Specification of the issue
  • User: Free
  • Premium support: No
  • Technology: React
  • MDB Version: 4.17.0
  • Device: laptop
  • Browser: Chrome
  • OS: Windows 10
  • Provided sample code: No
  • Provided link: No
Tags