decision: frontend documentation #161
Conversation
Bushuo
requested review from
markus2330,
buenaflor,
badnames,
absurd-turtle and
ThorbenStaufer
|
I could include screenshots of how the embedded documentation looks in my local setup, if you want to see :) |
|
|
||
| 1. With a good and beautiful documentation tool, developers are more likely to use and maintain it. | ||
| 2. With a documentation tool that enables the viewing of react components, the code quality is improved. Presentation components, should not contain logic with side effects. | ||
| Hooks should be used outside of presentation components, with props passed into them. |
There was a problem hiding this comment.
This should be in general guidelines about frontend (architecture), and we should like from here to this document.
There was a problem hiding this comment.
@markus2330 I added it to contrib/frontend.
| ## Decision | ||
| We will use [Storybook](https://storybook.js.org/) to enable a project wide component overview and style-guide. | ||
| It has support for `MDX`, a format that enables embeddable components in markdown. | ||
| It has support for automated testing via `Jest` and `Playwright`. |
There was a problem hiding this comment.
Maybe we can also immediately decide on that?
There was a problem hiding this comment.
(But maybe in a separate PR because it seems like we already have consensus about the rest.)
There was a problem hiding this comment.
This is still open. Can you please comment on #39.
|
Yes, if you already created screenshots it would be nice to see. |
|
Hi @markus2330
These are two screenshots from my local setup. I changed how the typedoc-plugin-markdown renders the markdown files, such that they can be recognized by storybook directly. There is still some work to do, to make the linking and hierarchical structure of the generated files work. I guess it is a good start. |
|
The local storybook setup, I have been working on, now displays all generated typedoc documentation files, links between them, and search 🎉🎉 |
|
Great to see it! Please fix the remaining small things so that we can get this merged! |
Co-authored-by: Markus Raab <[email protected]>
Co-authored-by: Markus Raab <[email protected]>
Bushuo
force-pushed
the
decision/frontend_documentation
branch
from
ff1f716 to
1820079
Compare
There was a problem hiding this comment.
Great job, a few minor last suggestions. Please (automatically) reformat this Markdown file so that it is consistent, see #159. Please tell everyone about this decision next meeting.
| ## Decision | ||
| We will use [Storybook](https://storybook.js.org/) to enable a project wide component overview and style-guide. | ||
| It has support for `MDX`, a format that enables embeddable components in markdown. | ||
| It has support for automated testing via `Jest` and `Playwright`. |
There was a problem hiding this comment.
This is still open. Can you please comment on #39.
| ``` | ||
|
|
||
| ### How to structure a storybook | ||
| https://storybook.js.org/blog/structuring-your-storybook/ |
There was a problem hiding this comment.
This should then also be in the main documentation.
There was a problem hiding this comment.
I added it to the Helpful Links section
|
Great job! Looking forward to see this realized. |
Closes #128
Basics
(first line should have
module: short statementsyntax)close #X, are in the commit messages.Checklist
(not in the PR description)
Review