From 93d8f8cd63ee5c24f527aeacd6c0a2d0e54db5fb Mon Sep 17 00:00:00 2001 From: Ward Bell Date: Mon, 17 Apr 2017 10:12:10 -0700 Subject: [PATCH] docs(aio): add VS Code advice to readme.md --- aio/README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/aio/README.md b/aio/README.md index 7df25bb2b2..999183fb0a 100644 --- a/aio/README.md +++ b/aio/README.md @@ -54,9 +54,11 @@ extracting the documentation and generating JSON files that can be consumed by t Full doc generation can take up to one minute. That's too slow for efficient document creation and editing. -While you can make small changes in a smart editor that displays formatted markdown (e.g,. VS Code), you -also want to see those changes displayed properly in the doc viewer. You'll want a quicker edit/view cycle -time. +You can make small changes in a smart editor that displays formatted markdown: +>In VS Code, _Cmd-K, V_ opens markdown preview in side pane; _Cmd-B_ toggles left sidebar + +You also want to see those changes displayed properly in the doc viewer +with a quick, edit/view cycle time. For this purpose, use the `yarn docs-watch` task, which watches for changes to source files and only re-processes the the files necessary to generate the docs that are related to the file that has changed.