-
-
Notifications
You must be signed in to change notification settings - Fork 497
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
Octane guides review: ensure code examples are complete #583
Comments
Here is a tool that we used to verify all of the code blocks during the AngleBrackets migration: #589 I don't know how useful it would be to you but it's there if you need it 🎉 |
I think there are a couple approaches with short and long term approaches.
npx prettier --parser markdown --single-quote --write "guides/release/**/*.md" I did try integrating prettier with the |
Closed by a dozen or so PRs ahead of EmberConf |
Thanks everyone for your help! |
The octane guides (#455) are coming along really well!
One thing that we could use some help with is reviewing all markdown "fenced code blocks"
are...
Valid language syntax.
A good way of checking this is to open up https://babeljs.io/repl and paste a code sample in the left editor pane.
Complete
Some of them seem to be missing imports, particularly for decorators like
@tracked
,@action
, etc... The good news is, other examples are complete, and will provide an indication of where to import from.If examples use something like "..." to provide an excerpt, please make sure it's in a comment, so that if readers copy/paste code into their editor, it's only incomplete and not broken.
The text was updated successfully, but these errors were encountered: