O
O
oskar barin2020-01-12 16:05:13
React
oskar barin, 2020-01-12 16:05:13

How to maintain documentation for react components?

With the growth of the project comes the need for documentation of react components.
What to use for component documentation?
Please share your experience

Answer the question

In order to leave comments, you need to log in

2 answer(s)
A
Andrew, 2020-01-16
@iCoderXXI

It is necessary to document, first of all, the business logic

A
Aleksei Podgaev, 2020-01-19
@alexiusp

It depends on what you mean by documentation and how the project is organized. As correctly written above, the most important thing is to document the logic. How exactly to do this depends on the team - as it is more convenient. Most likely you will come to readme in repositories and/or docs in google docs or confluence.
If your project has grown so much that it has acquired a style guide and it is time to move the components to a separate library, then you can document this library as well. For these purposes, I personally like React Styleguidist. But it may not work for you. There are other alternatives, just google and try each one to see which one is more convenient for you.

Didn't find what you were looking for?

Ask your question

Ask a Question

731 491 924 answers to any question