Skip to content

Commit

Permalink
website: update docs to v5
Browse files Browse the repository at this point in the history
  • Loading branch information
ealush committed Sep 6, 2023
1 parent e078eed commit 76fe771
Show file tree
Hide file tree
Showing 5 changed files with 12 additions and 39 deletions.
8 changes: 2 additions & 6 deletions website/docs/get_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,15 @@ keywords: [Vest, Get started, Quickstart, Validation, JavaScript]

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.

## Development status

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:

## Installation

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

```
npm i vest@next
npm i vest
```

This will install the next version of Vest in your project.
This will install Vest in your project.

## Writing your first suite

Expand Down
8 changes: 0 additions & 8 deletions website/docs/upgrade_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,14 +7,6 @@ keywords: [Vest, Upgrade]

# Upgrading from V4 to V5

### Installation

Vest@5 is currently in latest testing phase. To install it, use the `next` tag:

```bash
npm install vest@next
```

### Migration guide

Vest 5 is mostly compatible with Vest 4, but some changes were made. In most cases, if you do not change anything, vest will keep working as it did before. However, to take advantage of the new features, you'll need to make some changes.
Expand Down
15 changes: 4 additions & 11 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -33,11 +33,14 @@ const config = {
sidebarPath: require.resolve('./sidebars.js'),
// Please change this to your repo.
editUrl: 'https://github.com/ealush/vest/edit/latest/website/',
lastVersion: '4.x',
lastVersion: 'current',
versions: {
'4.x': {
label: '4.x',
},
current: {
label: '5.x',
},
},
},
pages: {
Expand Down Expand Up @@ -106,16 +109,6 @@ const config = {
type: 'docsVersionDropdown',
position: 'left',
},

{
position: 'right',
type: 'html',
value: badgeLink(
'/vest-5-is-ready',
'https://badgen.net/npm/v/vest/next?scale=1.2',
'next-badge'
),
},
{
position: 'right',
type: 'html',
Expand Down
10 changes: 5 additions & 5 deletions website/src/pages/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -27,8 +27,8 @@ function HomepageHeader() {
</div>
<div className={styles.buttons}>
<Link
className={clsx('button', styles.btn, styles.btnQuickStart)}
to="/docs/get_started"
className={clsx('button', styles.btn, styles.btnPromote)}
to="/vest-5-is-ready"
>
Quick Start Guide
</Link>
Expand All @@ -44,10 +44,10 @@ function HomepageHeader() {
</div>
<div className={styles.buttons}>
<Link
className={clsx('button', styles.btn, styles.btnPromote)}
to="/vest-5-is-ready"
className={clsx('button', styles.btn, styles.btnQuickStart)}
to="/docs/upgrade_guide"
>
Try The New Version!
V5 Upgrade Guide
</Link>
</div>
</header>
Expand Down
10 changes: 1 addition & 9 deletions website/src/pages/vest-5-is-ready.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,14 +33,6 @@ As developers, your feedback is crucial to helping us improve Vest@5 and make it
- **Review the Documentation:** The documentation was updated to include both the version 4 and version 5 docs. Please review the documentation and reach out if anything is unclear or needs improvement.
- **Share Your Thoughts:** Whether you have suggestions for new features or behaviors, or simply want to share your overall experience with the API, I want to hear from you! You can provide feedback by writing on the [dedicated issue](https://github.com/ealush/vest/issues/1018), sending a message on the [Vest Discord server](https://discord.com/invite/WmADZpJnSe) or reaching out to us on [Twitter](https://twitter.com/vestjs).

## Getting Started

To get started with Vest@5, simply install it using the `next` tag:

```
npm install vest@next
```

For those who are currently using version 4, migration docs are available to make the transition as smooth as possible. You can find these docs on the [documentation website](/docs/next/upgrade_guide).
For those who are currently using version 4, migration docs are available to make the transition as smooth as possible. You can find these docs on the [documentation website](/docs/upgrade_guide).

Happy Vesting! 🚀

0 comments on commit 76fe771

Please sign in to comment.