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

Story addon not displaying code example #1119

Open
SimonFinney opened this issue Aug 5, 2021 · 6 comments
Open

Story addon not displaying code example #1119

SimonFinney opened this issue Aug 5, 2021 · 6 comments
Labels
type: bug 🐛 Something isn't working type: docs 📖 Improvements or additions to documentation

Comments

@SimonFinney
Copy link
Contributor

SimonFinney commented Aug 5, 2021

Remove addon 'Story' for IBM Cloud Cognitive stories

Does this sort of thing work?

Secondary.story = {
  parameters: { 
    knobs: {
      disabled: true
    } 
  }
};

Issue raised by product team:

Story

@SimonFinney SimonFinney added type: bug 🐛 Something isn't working type: docs 📖 Improvements or additions to documentation labels Aug 5, 2021
@dcwarwick
Copy link
Contributor

The Story tab has never been useful for stories created from templates. The source code displayed in the previews on the docs page is far from perfect, but is much more useful than the raw story source -- I think it is generated by sniffing the running component. Does anyone know if there's an addon to present this in a 'Story' tab instead of the actual source code?

@SimonFinney
Copy link
Contributor Author

The Story tab has never been useful for stories created from templates. The source code displayed in the previews on the docs page is far from perfect, but is much more useful than the raw story source -- I think it is generated by sniffing the running component. Does anyone know if there's an addon to present this in a 'Story' tab instead of the actual source code?

I couldn't find anything after a quick browse of the addons catalog. 🤔

Should we consider removing the 'Story' addon entirely if it's of no use? Or alternatively, working towards moving away from Template.bind and 'spelling out' stories instead, similarly to Carbon, which may not be worth the effort — I'd like to understand whether consumers are significantly impacted by this before making any drastic decisions. 😆

@lee-chase lee-chase changed the title Story addon not displaying code example Story addon not displaying code example - Remove addon Mar 23, 2022
@lee-chase lee-chase changed the title Story addon not displaying code example - Remove addon Story addon not displaying code example Mar 23, 2022
@lee-chase
Copy link
Member

Remove addon 'Story' for IBM Cloud Cognitive stories

Does this sort of thing work?

Secondary.story = {
  parameters: { 
    knobs: {
      disabled: true
    } 
  }
};

@SimonFinney
Copy link
Contributor Author

Does this sort of thing work?

Good question — I don't see it documented, but it might be worth testing it with the storysource parameter 🤞🏻:

Example.story = {
  parameters: {
    storysource: {
      disabled: true,
    },
  },
};

@stale
Copy link

stale bot commented May 27, 2023

Is this still relevant? If so, what is blocking it? Is there anything you can do to help move it forward?

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs.

@stale stale bot added the status: won’t fix 🔚 This will not be worked on label May 27, 2023
@elycheea
Copy link
Contributor

Will tag @lee-chase to consider later as we investigate #2846

@stale stale bot removed the status: won’t fix 🔚 This will not be worked on label May 30, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: bug 🐛 Something isn't working type: docs 📖 Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

4 participants