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

Addon-docs: Refactor docs support into individual framework packages #17695

Merged
merged 17 commits into from
Mar 14, 2022

Conversation

shilman
Copy link
Member

@shilman shilman commented Mar 12, 2022

Issue: #16210

What I did

  • Created a new library @storybook/docs-tools to contain common functions
  • Moved framework into angular, ember, html, react, svelte, vue, vue, web-components
  • Cleaned up addon-docs complex preset system

In the telescoping PR #17697

  • Added the ability to disable docs support for these packages
  • Updated the documentation

What to review

  1. Naming: does docs-tools make sense?
  2. Overall structure: does the framework update with the preset-framework-docs, which in turn calls into docs-tools make sense? Does this bloat the framework packages in some way that I'm missing, other than what's handled in Addon-docs: Auto-disable docs presets if docs/controls unused #17697?

How to test

I tested this using Storybook test-runner, doing visual snapshot tests against the docs pages in both next and this branch.

You can see the feature/instructions here: storybookjs/test-runner#79

@nx-cloud
Copy link

nx-cloud bot commented Mar 12, 2022

☁️ Nx Cloud Report

CI ran the following commands for commit a84f75a. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch


✅ Successfully ran 1 target

Sent with 💌 from NxCloud.

@shilman shilman added maintenance User-facing maintenance tasks addon: docs labels Mar 12, 2022
@shilman shilman changed the title Addon-docs: Refactor common libraries into docs-utils Addon-docs: Refactor docs support into individual framework packages Mar 12, 2022
Copy link
Member

@tmeasday tmeasday left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

lib/docs-tools/README.md Show resolved Hide resolved
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
addon: docs maintenance User-facing maintenance tasks
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants