Skip to content

Commit 8181e97

Browse files
committed
docs: set default docs to current
1 parent 8534ffc commit 8181e97

File tree

5 files changed

+32
-12
lines changed

5 files changed

+32
-12
lines changed

website/docs/get_started.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,17 +7,21 @@ keywords: [Vest, Get started, Quickstart, Validation, JavaScript]
77

88
# Introduction to Vest
99

10-
Vest is a JavaScript validation framework that allows you to write and run validations for your code. It is designed to be simple to use while still being powerful enough to handle complex validation scenarios. In this guide, we'll walk you through the process of installing Vest and writing your first validation suite.
10+
Vest is a powerful and easy-to-use JavaScript validation framework that allows you to write and run validations for your code. It is designed to handle complex validation scenarios while still being simple to use. This guide will show you how to install and use Vest@5, the latest version of the framework that's currently in development.
11+
12+
## Development status
13+
14+
Vest@5 is currently in its final development stages and all features are already supported. Although it has not been officially released yet, you can still install and use it by installing the "next" tag with the following command:
1115

1216
## Installation
1317

1418
To get started with Vest, you will need to install it using npm. Open up your terminal and run the following command:
1519

1620
```
17-
npm i vest
21+
npm i vest@next
1822
```
1923

20-
This will install the latest stable version of Vest in your project.
24+
This will install the next version of Vest in your project.
2125

2226
## Writing your first suite
2327

website/docusaurus.config.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -39,10 +39,10 @@ const config = {
3939
sidebarPath: require.resolve('./sidebars.js'),
4040
// Please change this to your repo.
4141
editUrl: 'https://github.com/ealush/vest/edit/latest/website/',
42-
lastVersion: 'current',
42+
lastVersion: '4.x',
4343
versions: {
44-
current: {
45-
label: '5.x',
44+
'4.x': {
45+
label: '4.x',
4646
},
4747
},
4848
},

website/src/pages/index.js

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ function HomepageHeader() {
4242
Github
4343
</Link>
4444
</div>
45+
<div className={styles.buttons}>
46+
<Link
47+
className={clsx('button', styles.btn, styles.btnPromote)}
48+
to="/docs/next/get_started"
49+
>
50+
Try The Next Version!
51+
</Link>
52+
</div>
4553
</header>
4654
);
4755
}

website/src/pages/index.module.css

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,10 @@
4949
width: 100%;
5050
}
5151

52+
.buttons + .buttons {
53+
margin-top: 1rem;
54+
}
55+
5256
.btn {
5357
border: none;
5458
font-weight: 400;
@@ -81,6 +85,16 @@
8185
background: #d0d2d7;
8286
}
8387

88+
.btnPromote {
89+
color: var(--ifm-color-primary-lightest);
90+
background: #e91e63;
91+
}
92+
93+
.btnPromote:hover {
94+
background: #bc124c;
95+
color: var(--ifm-color-primary-lightest);
96+
}
97+
8498
.logoContainer {
8599
height: 300px;
86100
width: 300px;

website/versioned_docs/version-4.x/get_started.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,6 @@ To install the stable version of Vest, run:
1515
npm i vest
1616
```
1717

18-
You can also embed Vest directly as a script tag in your page:
19-
20-
```html
21-
<script src="https://unpkg.com/vest@4/dist/umd/vest.production.js"></script>
22-
```
23-
2418
## Writing your first suite
2519

2620
A Vest suite is very similar to a unit testing suite in Jest or Mocha, so the following might look familiar:

0 commit comments

Comments
 (0)