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

Refine source examples in individual stories #1289

Closed
tylersticka opened this issue Jun 7, 2021 · 3 comments
Closed

Refine source examples in individual stories #1289

tylersticka opened this issue Jun 7, 2021 · 3 comments
Assignees
Labels
👷 dev 📚 documentation Improvements or additions to documentation

Comments

@tylersticka
Copy link
Member

tylersticka commented Jun 7, 2021

Our code previews to date were developed before we had anything close to useful source previews.

As of #1285, we not only have really nice automatic source previews, but we also have a new utility function we can use to generate previews more manually in cases where our demo source must be disconnected somewhat from the actual theme code.

This issue represents going through our existing stories and making the necessary changes to improve the source previews where possible. Changes may include:

  • Simplifying demos that may be replaced with the actual template and args
  • Specifying the Story element's source or templateSource parameters using the aforementioned utility function
  • When a story is particularly complex, unique or time-consuming, adding a TODO comment or creating a separate issue to refine at a later date
@tylersticka tylersticka added 📚 documentation Improvements or additions to documentation size:? ✋ blocked Can't proceed quite yet 👷 dev labels Jun 7, 2021
@tylersticka tylersticka changed the title Refine source in individual stories Refine source examples in individual stories Jun 7, 2021
@tylersticka tylersticka removed the ✋ blocked Can't proceed quite yet label Jun 7, 2021
@tylersticka tylersticka self-assigned this Jun 7, 2021
@tylersticka tylersticka removed their assignment Jun 7, 2021
@gerardo-rodriguez gerardo-rodriguez self-assigned this Jun 11, 2021
@gerardo-rodriguez
Copy link
Member

Am I correct in understanding the source code previews can't handle block content? For example, the Card component has multiple content blocks, is this an example of a component we leave alone for now?

@tylersticka
Copy link
Member Author

I don't think there's any component we couldn't address in some fashion using one of the bullets in this issue's description. If all else fails, you can manually specify a string ({% block 'content' %}...{% endblock %}) representing the block.

@gerardo-rodriguez
Copy link
Member

@tylersticka I created #1447 to break out the work left for the Objects.

I will go ahead and call this card "done". 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
👷 dev 📚 documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

3 participants