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

using field-guide to document instead of markdown-templates #186

Merged
merged 1 commit into from
Jun 25, 2019

Conversation

mansona
Copy link
Member

@mansona mansona commented Jun 24, 2019

Closes #180

This PR simplifies the documentation and hosting of the ember-styleguide (for the website redesign branch)

Before this PR we were using an addon called ember-markdown-templates that was difficult to use and required you to be careful with how you did documentation.

This PR starts using field-guide that allows us to just write Markdown with code examples that are self-executing, which allows for very straight forward documentation and demonstration.

Let me know if anyone has any questions, I would like to get this PR merged this week so that work can continue on the redesign effort 👍

Note for reviewers: you will see a lot of deletions in this PR, this is not actually removing any documentation. Now that code examples are self-executing you no longer need to duplicate the code in the example directly after code-block, and the deletions you are seeing are just these duplicates being removed because they are no longer necessary.

@mansona mansona requested a review from a team June 24, 2019 22:04
@mansona
Copy link
Member Author

mansona commented Jun 24, 2019

let me know if anyone has any questions 👍

@mansona mansona mentioned this pull request Jun 24, 2019
@sivakumar-kailasam
Copy link
Member

A lot of components don’t seem to be functioning as expected. eg., on the footer page the styles seem to be broken & on the button page the disabled state doesn't seem to be set. Are these expected/known?

@mansona
Copy link
Member Author

mansona commented Jun 25, 2019

@sivakumar-kailasam yes this is known already because they haven't been implemented in the redesign branch yet 👍

@sivakumar-kailasam
Copy link
Member

sivakumar-kailasam commented Jun 25, 2019 via email

Copy link
Member

@MelSumner MelSumner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for doing this!! 👍

@MelSumner MelSumner merged commit 5a49d43 into website-redesign-rfc Jun 25, 2019
@delete-merged-branch delete-merged-branch bot deleted the using-field-guide branch June 25, 2019 14:03
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.

3 participants