Skip to content

Commit ff05551

Browse files
committed
chore(docs): fix typo and update title
1 parent 76fe779 commit ff05551

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -75,6 +75,7 @@ Nodes additionally need an __XY-position__, while edges require a __source__ and
7575
```vue
7676
<!-- Flowchart.vue -->
7777
<script setup>
78+
import { ref } from 'vue'
7879
import { VueFlow } from '@vue-flow/core'
7980
8081
const nodes = ref([

docs/src/guide/getting-started.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -43,14 +43,14 @@ $ yarn add @vue-flow/core
4343

4444
:::
4545

46-
## Usage
46+
## Quick Start
4747

48-
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node)and [**edges**](/typedocs/types/Edge), all of which are categorised as [**elements**](/typedocs/types/Elements).
48+
In Vue Flow, a graph consists of [**nodes**](/typedocs/interfaces/Node) and [**edges**](/typedocs/types/Edge).
4949

50-
**Each node and edge requires a unique id.**
50+
**Each node or edge requires a unique id.**
5151

52-
Nodes also need an [XY-position](/typedocs/interfaces/XYPosition), while edges require a `source` and a
53-
`target`, both represented by node ids.
52+
Nodes also need a [XY-position](/typedocs/interfaces/XYPosition), while edges require a `source` and a
53+
`target` node id.
5454

5555
::: warning NOTE!
5656
To ensure Vue Flow's is correctly displayed, make sure you include the necessary styles.

docs/src/guide/node.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62,8 +62,7 @@ For the full list of options available for a node, check out the [Node Interface
6262

6363
## Adding Nodes to the Graph
6464

65-
Nodes are generally created by adding them to the `mode-value` (using `v-model`) or to the `nodes` prop of the Vue Flow component.
66-
This can be done dynamically at any point in your component's lifecycle.
65+
Nodes are rendered by passing them to the `nodes` prop (or the deprecated `v-model` prop) of the Vue Flow component.
6766

6867
:::code-group
6968

0 commit comments

Comments
 (0)