react-styleguidist
react-styleguidist copied to clipboard
Moved component locations should be marked as breaking changes
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.
We can't guarantee that locations or APIs of internal component will never change, and we can't treat them as breaking change ether. Feel free to send a pull request to the docs to clarify that.
Maybe we should maintain a public API mapping where we expose components? Extensibility is one of the great aspects of styleguidist and I think it's a valid point that such changes should not break existing usages.
This sounds great in theory but in practice I don't see it practical. And like with any “we should do”, someone will actually have to do this work.
@benwiley4000 Can i get this issue ,I have to contribute to it