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

Use example component partial as code example and screenshotable component #42

Closed
wants to merge 1 commit into from

Conversation

bensheldon
Copy link
Contributor

@bensheldon bensheldon commented Dec 21, 2018

  • Renders out the file contents of the component's example partial (living under views/cfa/styleguide/examples) for the styleguide's code example. This makes the documentation closer to how component would be used in ERB, and allows more complex (e.g. multiline or components that use yield or capture) examples. screen shot 2018-12-21 at 8 25 29 am

  • Creates a URL path for each component example. This could be used as a target for Happo as described in Set up CI #4. Example: http://localhost:3000/cfa/styleguide/examples/molecules/progress_step_bar

screen shot 2018-12-21 at 8 26 15 am

  • I extracted out the styleguide section into a separate partial too. I still see some complexity/potential-confusion in differentiating when a full partial path is being passed as an argument versus a component "identifier" that is then expanded into a full partial path.

@bensheldon
Copy link
Contributor Author

Pattern has been superseded.

@bensheldon bensheldon closed this Jan 3, 2019
@bensheldon bensheldon deleted the example_partial branch January 3, 2019 20:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant