Skip to content
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

Implement automatic Storybook Docs generation and refresh with compodoc for Angular projects #3918

Closed
dobromyslov opened this issue Oct 15, 2020 · 2 comments
Labels
outdated scope: storybook Issues related to Storybook support in Nx stale type: feature

Comments

@dobromyslov
Copy link

dobromyslov commented Oct 15, 2020

Description

  1. Add Storybook Essential addons. Feature request: Storybook enhancement: Change story templates to include types and @storybook/addon-essentials, alongside addon-knobs #3895
  2. Automatically install @twittwer/compodoc NX plugin with Storybook Essential addons.
  3. Configure Storybook Docs addon to use generated compodoc.json file.
  4. When I run ng run projectname:storybook for an Angular project it should run ng run projectname:compodoc:json
  5. When ng run projectname:storybook is running it should watch for changes in components and rerun ng run projectname:compodoc:json

Motivation

  1. Add Storybook Docs addon support for Angular projects.
  2. Add Storybook Controls addon automatic inputs detection.
  3. Eliminate complicated configuration of Storybook + Essential addons + NX compodoc community plugin.
  4. Eliminate manual compodoc rerun on each component change.

Current configuration of this stack and workflow is described here: twittwer/nx-tools#19 (comment)

Suggested Implementation

As described above.

Alternate Implementations

Workaround: twittwer/nx-tools#19 (comment)

@dobromyslov dobromyslov changed the title Implement automatic Storybook Docs generation and refresh with compodoc for Angular Implement automatic Storybook Docs generation and refresh with compodoc for Angular projects Oct 15, 2020
@mandarini mandarini added the scope: storybook Issues related to Storybook support in Nx label Oct 16, 2020
@github-actions
Copy link

This issue has been automatically marked as stale because it hasn't had any recent activity. It will be closed in 14 days if no further activity occurs.
If we missed this issue please reply to keep it active.
Thanks for being a part of the Nx community! 🙏

@github-actions
Copy link

This issue has been closed for more than 30 days. If this issue is still occuring, please open a new issue with more recent context.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Mar 24, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
outdated scope: storybook Issues related to Storybook support in Nx stale type: feature
Projects
None yet
Development

No branches or pull requests

2 participants