Improve CLI commands reference

ember-learn / cli-guides

Step-by-step guides and tutorials for using the ember-cli to create apps and addons

https://cli.emberjs.com

MIT License

25 stars 76 forks source link

Improve CLI commands reference #207

Closed neojp closed 3 years ago

neojp commented 3 years ago

Add table of contents with links to each command
Add anchored headings to each command
Add description to each command

Related #162

Screenshots

jenweber commented 3 years ago

Hello! This is wonderful, thank you! I can help with the failing tests and build later today. We can configure the spell checker to ignore this page. I’m not sure why the build broke but it’s probably just a little thing.

neojp commented 3 years ago

Thank you! I was looking through the CI errors and was wondering why the build was failing. I'll try building it locally too.

jenweber commented 3 years ago

Ok, to exclude this page from spellchecking, add this line to .remarkignore:

guides/advanced-use/cli-commands-reference.md

The Netlify deploy is failing due to a problem with dependency caching, 100% unrelated to your changes. You can ignore that problem, and I'll see if I can sort out what's wrong separately.

neojp commented 3 years ago

I decided to wrap the headings and any references to the CLI commands with <code> to avoid the linter from erroring out. The CI tests are all green now! 🚀