dillonkearns/elm-pages-v3-beta
1
1
Fork 0
mirror of https://github.com/dillonkearns/elm-pages-v3-beta.git synced 2024-12-25 21:02:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

Update error-style-guide.md

Browse Source
This commit is contained in:
Dillon Kearns 2019-11-05 13:38:33 -08:00 committed by GitHub
parent abba86c010
commit d0fa4f7841
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/error-style-guide.md
View File

@ -88,6 +88,14 @@ Examples:
## Educational Material ## Educational Material
How can we present information and resources that help them understand concepts that they might be missing that they need to solve their issue or accomplish their goal? How can we present information and resources that help them understand concepts that they might be missing that they need to solve their issue or accomplish their goal?
Key ideas
* Often the user is trying to accomplish something different than the error message context would imply. For
example, if they are running into an error message about parsing frontmatter, they may
just need some help understanding the concept of what frontmatter is, what the valid syntax is,
or how it differs from tools with special frontmatter directives (like Jekyll). So the context is
that their decoder is failing... but that context may not point them in the direction they need at all.
This is often the purpose that educational material serves.
Examples: Examples:
* "I was trying to parse the frontmatter for page ..., but there was no frontmatter. Frontmatter is metadata about a page, for example a page might have a title or a published date or a list of tags. See link to learn more about frontmatter and best practices for using it with `elm-pages`" * "I was trying to parse the frontmatter for page ..., but there was no frontmatter. Frontmatter is metadata about a page, for example a page might have a title or a published date or a list of tags. See link to learn more about frontmatter and best practices for using it with `elm-pages`"
* Many static site frameworks have custom frontmatter directives. In `elm-pages`, you define a JSON decoder, and then decide what to do with that parsed data in your `view` function. Learn more at elm-pages.com/docs/elm-pages-architecture * Many static site frameworks have custom frontmatter directives. In `elm-pages`, you define a JSON decoder, and then decide what to do with that parsed data in your `view` function. Learn more at elm-pages.com/docs/elm-pages-architecture