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

[Documentation]: API documentation changes #30602

Open
jonniebigodes opened this issue Feb 20, 2025 · 0 comments
Open

[Documentation]: API documentation changes #30602

jonniebigodes opened this issue Feb 20, 2025 · 0 comments

Comments

@jonniebigodes
Copy link
Contributor

jonniebigodes commented Feb 20, 2025

Describe the problem

Some APIs will be removed or changed in the upcoming release. Therefore, the documentation should be vetted to ensure that all references to the removed or changed APIs are updated accordingly.

The following APIs will be removed:

  • Manager API

    • DeprecatedState
    • getAddonState
    • setAddonState
  • Preview API

    • addons
    • mockChannel
    • fromId
    • getSetStoriesPayload
    • getStoriesJsonData
    • globals (replaced with initialGlobals)
    • raw
    • storyStore
  • Misc

    • project annotations's renderToDOM
    • autodocs from the DocsOptions configuration object (requires vetting any existing references across multiple outlets for consistency)
  • Types

    • Addon_SidebarBottomType
    • Addon_SidebarTopType
    • frameworkToRenderer
    • subcomponents
    • SupportedRenderers

What needs to happen:

  • Vet the documentation to ensure that all references to the removed or changed APIs are updated accordingly
  • Remove any examples or references to the removed APIs
  • Adjust the Migration guide to reflect the changes in the API

Additional context

No response

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
Status: No status
Development

No branches or pull requests

1 participant