Skip to content

Commit

Permalink
docs: guides are completed
Browse files Browse the repository at this point in the history
  • Loading branch information
mahabubx7 committed Oct 16, 2024
1 parent 8497c58 commit 797926f
Show file tree
Hide file tree
Showing 12 changed files with 18 additions and 12 deletions.
2 changes: 1 addition & 1 deletion docs/api/array.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Array

::: info
We are wotking on it.
Work in progress ⏳
:::
2 changes: 1 addition & 1 deletion docs/api/boolean.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Boolean

::: info
We are wotking on it.
Work in progress ⏳
:::
2 changes: 1 addition & 1 deletion docs/api/enum.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Enum

::: info
We are wotking on it.
Work in progress ⏳
:::
4 changes: 2 additions & 2 deletions docs/api/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 ⏳
:::
2 changes: 1 addition & 1 deletion docs/api/number.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Number

::: info
We are wotking on it.
Work in progress ⏳
:::
2 changes: 1 addition & 1 deletion docs/api/object.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Object

::: info
We are wotking on it.
Work in progress ⏳
:::
2 changes: 1 addition & 1 deletion docs/api/string.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# String

::: info
We are wotking on it.
Work in progress ⏳
:::
2 changes: 1 addition & 1 deletion docs/greetings.md
Original file line number Diff line number Diff line change
@@ -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.
:::

Expand Down
6 changes: 6 additions & 0 deletions docs/guide/get-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down
2 changes: 1 addition & 1 deletion docs/guide/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
2 changes: 1 addition & 1 deletion docs/guide/schema-validation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

:::

Expand Down
2 changes: 1 addition & 1 deletion docs/team.md
Original file line number Diff line number Diff line change
Expand Up @@ -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' }
]
},
Expand Down

0 comments on commit 797926f

Please sign in to comment.