Documenting React applications
We have put a lot of work and code into our React application. To be honest, we can improve upon our code base by documenting it. We did not comment on our code, we did not add React component property-type definitions, and we have no automated documentation tool. Of course, we did not write any comments because you learned all of the techniques and libraries from the book, so no comments were needed. However, be sure to always comment your code outside of this book.
In the JavaScript ecosystem, many different approaches and tools exist to document your application. For this book, we will use a tool called React Styleguidist. It was made especially for React. You cannot document other frameworks or code with it.
Important Note
Generally speaking, this is an area that you can put months of work into without coming to a real end. If you are searching for a general approach for any framework or backend and frontend, I can recommend JSDoc, but there...
