using field-guide to document instead of markdown-templates #186
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.