From b94c0ab607b8869cc8793cf2cf5c865d11de7f9e Mon Sep 17 00:00:00 2001
From: Braks <78412429+bcakmakoglu@users.noreply.github.com>
Date: Mon, 11 Apr 2022 16:06:45 +0200
Subject: [PATCH] docs: Update guide wordings
---
docs/components/home/flows/Intro.vue | 2 +-
docs/src/guide/index.md | 29 +++++++++++++++-------------
2 files changed, 17 insertions(+), 14 deletions(-)
diff --git a/docs/components/home/flows/Intro.vue b/docs/components/home/flows/Intro.vue
index 85b53afa..ac874a71 100644
--- a/docs/components/home/flows/Intro.vue
+++ b/docs/components/home/flows/Intro.vue
@@ -133,7 +133,7 @@ onPaneReady(({ fitView }) => {
Vue Flow
- A customizable Vue.js library for building node-based editors and diagrams.
+ The customizable Vue 3 component bringing interactivity to flowcharts and graphs.
diff --git a/docs/src/guide/index.md b/docs/src/guide/index.md
index 4fb0735b..9c29fd3a 100644
--- a/docs/src/guide/index.md
+++ b/docs/src/guide/index.md
@@ -4,22 +4,26 @@ title: Introduction
# Introduction
-Vue Flow is a library for building node-based applications. These can be simple static diagrams or complex node-based
-editors. You can implement custom nodes and edges. It also comes with components like a mini-map, viewport controls and
-a background.
+## What is Vue Flow?
+
+Vue Flow is a Vue 3 library that brings interactivity to flowcharts and graphs.
+
+It is a tool to build your own diagrams, editors and whatever your imagination allows for.
+
+Easily implement your own custom nodes and edges and expand on the basic functionality and on top of that Vue Flow comes
+with a couple of additional components like a Background, a Minimap and Controls.
Check out the [examples](/examples/) if you want to dive directly into the code.
## Key Features
-
-- 👶 __Easy to use__: Seamless zooming & panning behaviour and single and multi-selections of
- elements
-- 🎨 __Customizable__: Different and edge types and support for custom nodes with multiple handles and custom edges
+- 👶 __Simple use__: Get started hassle-free - Built-in zoom- & pan features, element dragging, selection and much more
-- 🚀 __Fast rendering__: Only nodes that have changed are re-rendered and only those that are in the viewport are displayed (optionally)
+- 🎨 __Customizable__: Use your own custom nodes, edges, connection lines and expand on the Vue Flows functionality
-- 🧲 __Handy utilities__: Comes with graph helper and state composable functions for advanced uses
+- 🚀 __Fast__: Tracks changes reactively and only re-renders the appropriate elements
+
+- 🧲 __Utils & Composables__: Comes with graph helper and state composable functions for advanced uses
- 📦 __Additional Components__:
@@ -31,8 +35,7 @@ Check out the [examples](/examples/) if you want to dive directly into the code.
- 🦾 __Reliable__: Fully written in TypeScript
-::: warning
- Vue Flow is still version 0.x.x.
-
- Expect breaking changes between versions!
+::: warning Vue Flow is still version 0.x.x.
+
+Expect breaking changes between versions!
:::