-
-
Notifications
You must be signed in to change notification settings - Fork 9.1k
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
[Bug]: Descriptions from JSDocs not rendered for Angular stories in 7.0.0-beta.60 #21387
Comments
Good golly!! I just released https://github.com/storybookjs/storybook/releases/tag/v7.0.0-rc.4 containing PR #21629 that references this issue. Upgrade today to the
|
The original fix was reverted by #22048, because testing proved that it wasn't necessary anymore. However that is not the case apparently, as this issue is back. |
@valentinpalkovic @vanessayuenn FYI I have verified that the reproduction still exists in the latest version of Storybook (7.0.20 as of this comment). I had to delete the |
Can confirm this issue still exists using Angular 14.3 and Storybook 7.0.21. |
I can confirm that this is still an issue on Storybook 7.1.0 and Angular 16. It does not recognise JSDoc on any Angular components nor does it recognise the JSDoc on the Storybook meta and stories either. |
I have the same behavior, have you already found a solution for it? |
No. The only thing I've been doing for now is adding parameter descriptions where necessary. I feel that if its not fixed soon I may have to move to building custom MDX pages for each set of stories |
I am still experiencing this issue with Angular 16 and Storybook 7.6.4 |
same with angular 16.1.2 and storybook 7.6.6 |
I fixed my issue. Once I properly configured compodoc with my project the autodocs started working: https://storybook.js.org/docs/essentials/controls#controls-are-not-automatically-generated-for-my-component |
@valentinpalkovic It works when I have the components & storybook within the same repository. When I use a NPM Angular Monorepro (no learna or NX) it does not show the docs. The project structure looks like this: package.json
Do I need to configure / install something inside the my-library folder, so that projects/my-storybook can use the documentation? |
@bastiW If you want to tackle this issue, you would have to change this line:https://github.com/storybookjs/storybook/blob/next/code/frameworks/angular/src/builders/utils/run-compodoc.ts#L34 Maybe we can enhance the current logic around Would you like to tackle this? I could support you if there are any questions. @markb WDYT? Any concerns? |
I will give it try. |
@valentinpalkovic Could you please help? |
Describe the bug
I have a Storybook set up for an Angular library which is using autodocs. I have updated to CSF3.
If I put JSDocs above my exported functions, they do not appear in the Doc page, either for the main description or on the individual stories.
e.g. following the docs, I had the following, but the description is not rendered.
To Reproduce
https://github.com/freon27/storybook-issue-repro/
The doc page for Header should show the JSDocs (as far as I understand it).
System
No response
Additional context
No response
The text was updated successfully, but these errors were encountered: