Update docs

rchl · Nov 5, 2020 · 062ba73 · 062ba73
1 parent 1851d1c
commit 062ba73
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 3 deletions.
diff --git a/docs/snippet.md b/docs/snippet.md
@@ -45,11 +45,11 @@ Three sources supplement Vetur with scaffold snippets:
 The workspace/user Vetur snippet folders share the same structure:
 
 ```
-vetur/snippets
-├── docs
+vetur/snippets/
+├── docs/
 │   │   // Completed as `<docs>`. Will have default completion icon.
 │   └── docs.vue
-├── style
+├── style/
 │   │   // Completed as `<style>`. Will have CSS completion icon.
 │   │   // `template` and `script` folder will have HTML/JS icons.
 │   └── scss-module.vue 

diff --git a/docs/vti.md b/docs/vti.md
@@ -7,6 +7,15 @@ VTI (Vetur Terminal Interface) is a CLI that exposes some of Vetur's language fe
 - [x] Diagnostic errors
 - [ ] Formatting
 
+## Why
+
+VTI catches type-errors in Vue templates that's not catchable by either Vue or TypeScript alone.
+
+- Vue compiler: do not understand types.
+- TypeScript compiler: do not understand Vue templates.
+- VLS: Understand both to do [TS type-checking on Vue templates](https://vuejs.github.io/vetur/interpolation.html).
+- VTI: Surfaces VLS's errors on CLI for CI.
+
 ## Usage
 
 ```bash