styleguidist/react-styleguidist

Moved component locations should be marked as breaking changes

Open

#1,268 opened on Feb 7, 2019

View on GitHub
 (6 comments) (0 reactions) (0 assignees)TypeScript (1,416 forks)github user discovery
documentationgood first issuehelp wanted

Repository metrics

Stars
 (11,091 stars)
PR merge metrics
 (PR metrics pending)

Description

When upgrading to the beta I got this error:

./docs_helpers/DocsWrapper.js
Module not found: Can't resolve 'react-styleguidist/lib/rsg-components/StyleGuide/StyleGuideRenderer'

When I change the path to react-styleguidist/lib/client/rgs-components... it compiled.

Since these module locations have been treated as public API (for overrides), their change in location should be documented as a breaking change.

Contributor guide

Research direction
Identify the moved component locations in the codebase and update the changelog or migration guide to mark them as breaking changes.
Tech stack
typescriptreact
Domain
frontend
Issue type
Documentation
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Git
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
70