From 797926f505b7e7cff1e9a088bb9c1c85dbcd6b11 Mon Sep 17 00:00:00 2001 From: Mahabub Date: Thu, 17 Oct 2024 00:06:21 +0600 Subject: [PATCH] docs: guides are completed --- docs/api/array.md | 2 +- docs/api/boolean.md | 2 +- docs/api/enum.md | 2 +- docs/api/index.md | 4 ++-- docs/api/number.md | 2 +- docs/api/object.md | 2 +- docs/api/string.md | 2 +- docs/greetings.md | 2 +- docs/guide/get-started.md | 6 ++++++ docs/guide/index.md | 2 +- docs/guide/schema-validation.md | 2 +- docs/team.md | 2 +- 12 files changed, 18 insertions(+), 12 deletions(-) diff --git a/docs/api/array.md b/docs/api/array.md index cd11081..8a49575 100644 --- a/docs/api/array.md +++ b/docs/api/array.md @@ -1,5 +1,5 @@ # Array ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/api/boolean.md b/docs/api/boolean.md index 6c90eb4..2786843 100644 --- a/docs/api/boolean.md +++ b/docs/api/boolean.md @@ -1,5 +1,5 @@ # Boolean ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/api/enum.md b/docs/api/enum.md index f3950fb..ced2b34 100644 --- a/docs/api/enum.md +++ b/docs/api/enum.md @@ -1,5 +1,5 @@ # Enum ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/api/index.md b/docs/api/index.md index 1554f4e..27d6ff8 100644 --- a/docs/api/index.md +++ b/docs/api/index.md @@ -4,6 +4,6 @@ Welcome to the `Akar.js`. This page will walk you through the available API references of this library. -:::info -We are wotking on it. +::: info +Work in progress ⏳ ::: diff --git a/docs/api/number.md b/docs/api/number.md index 7685760..0cf9515 100644 --- a/docs/api/number.md +++ b/docs/api/number.md @@ -1,5 +1,5 @@ # Number ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/api/object.md b/docs/api/object.md index dc1cb32..34db6da 100644 --- a/docs/api/object.md +++ b/docs/api/object.md @@ -1,5 +1,5 @@ # Object ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/api/string.md b/docs/api/string.md index 69d858f..dc0be9b 100644 --- a/docs/api/string.md +++ b/docs/api/string.md @@ -1,5 +1,5 @@ # String ::: info -We are wotking on it. +Work in progress ⏳ ::: diff --git a/docs/greetings.md b/docs/greetings.md index f0af2f2..084b15d 100644 --- a/docs/greetings.md +++ b/docs/greetings.md @@ -1,7 +1,7 @@ # Welcome! ::: info -This package is available with its latest release `v1.0.1`. +This package is available with its latest release `v1.0.1` or later. It is still in `development` and very soon will have its first stable/lts release. ::: diff --git a/docs/guide/get-started.md b/docs/guide/get-started.md index 3cf6933..2f2572c 100644 --- a/docs/guide/get-started.md +++ b/docs/guide/get-started.md @@ -17,6 +17,12 @@ To install the npm package, follow these steps: 1. Open your terminal. 2. Run the following command to install the package: +::: tip + +We are assuming that `Deno ^2.0` runtime can use our package with its built-in node.js runtime supports. + +::: + ::: code-group ```sh [npm] diff --git a/docs/guide/index.md b/docs/guide/index.md index c204fb5..a7431e9 100644 --- a/docs/guide/index.md +++ b/docs/guide/index.md @@ -6,4 +6,4 @@ We recommend **node.js** `>=20.x` as the runtime to use our library without any ## Conclusion -This pkg was developed in Node.js runtime. Still it can be used in other `node.js` like runtimes such as `bun` or `deno 2.0` _(coming soon)_ +This pkg was developed in Node.js runtime. Still it can be used in other `node.js` like runtimes such as `bun` or `deno ^2.0` diff --git a/docs/guide/schema-validation.md b/docs/guide/schema-validation.md index d76a475..a0b1382 100644 --- a/docs/guide/schema-validation.md +++ b/docs/guide/schema-validation.md @@ -298,7 +298,7 @@ console.log(port.parse(65999)) // <-- errors ::: warning -If you face any issue or problem using this in JavaScript, please let us know. You can also create an issue for that. +If you face any issue or problem using this in JavaScript/TypeScript, please let us know. You can also create an issue for that. ::: diff --git a/docs/team.md b/docs/team.md index f064e1f..5f52394 100644 --- a/docs/team.md +++ b/docs/team.md @@ -16,7 +16,7 @@ const members = [ title: 'Creator', links: [ { icon: 'github', link: 'https://github.com/mahabubx7' }, - // { icon: '', link: ''}, + { icon: 'twitter', link: 'https://x.com/iam_mahabub'}, { icon: 'linkedin', link: 'https://linkedin.com/in/mahabubx7' } ] },