From cd3afac901ece57f8dae54926ecb5f08d7e74600 Mon Sep 17 00:00:00 2001
From: arobsn <87387688+arobsn@users.noreply.github.com>
Date: Tue, 9 Jul 2024 10:01:59 -0300
Subject: [PATCH] add contributing guide

---
 .github/contributing.md      | 16 ++++++++++++++++
 .github/workflows/deploy.yml |  2 +-
 README.md                    | 12 +++---------
 docs/.vitepress/config.ts    | 26 --------------------------
 docs/getting-started.md      |  4 ----
 package.json                 |  7 +++----
 6 files changed, 23 insertions(+), 44 deletions(-)
 create mode 100644 .github/contributing.md

diff --git a/.github/contributing.md b/.github/contributing.md
new file mode 100644
index 0000000..6b2d1f3
--- /dev/null
+++ b/.github/contributing.md
@@ -0,0 +1,16 @@
+## Contributing
+
+This site is built with [VitePress](https://github.com/vuejs/vitepress). Site content is written in Markdown format located in `docs`. For simple edits, you can directly edit the file on GitHub and generate a Pull Request.
+
+For local development, Node.js `v18` or higher and [pnpm](https://pnpm.io/) `v9` or higher are required:
+
+```bash
+pnpm i
+pnpm run dev
+```
+
+## Working on the content
+
+- See VitePress docs on supported [Markdown Extensions](https://vitepress.dev/guide/markdown).
+
+- We adopt the same [Writing Guide](https://github.com/vuejs/docs/blob/main/.github/contributing/writing-guide.md) as Vue.js for rules and recommendations on writing and maintaining documentation content.
diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml
index a15f7d8..79158b1 100644
--- a/.github/workflows/deploy.yml
+++ b/.github/workflows/deploy.yml
@@ -22,7 +22,7 @@ jobs:
       - run: pnpm install --frozen-lockfile
 
       - name: Build
-        run: pnpm run docs:build
+        run: pnpm run build
 
       - name: Deploy
         uses: peaceiris/actions-gh-pages@v3
diff --git a/README.md b/README.md
index 4f33852..66ef540 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,9 @@
-# 📄 Documentation for Fleet SDK
+# 📄 Fleet SDK docs
 
-[Fleet SDK](https://github.com/fleet-sdk/fleet) is an easy-to-use, modular, and extensible off-chain SDK (Software Development Kit)for the [Ergo Platform](https://ergoplatform.org/en/), written entirely in TypeScript.
-
-**Fleet SDK** is currently in alpha status. It is already suitable for out-of-the-box use, but the API may still change between minor releases.
-
-This repository is for the [Fleet SDK Documentation](https://fleet-sdk.github.io/docs/) website.
+[Fleet SDK](https://github.com/fleet-sdk/fleet) is an easy-to-use, modular, and extensible off-chain SDK (Software Development Kit) for the [Ergo Platform](https://ergoplatform.org/en/), written entirely in TypeScript.
 
 ## Contributing
 
 This site is built with [VitePress](https://github.com/vuejs/vitepress). Site content is written in Markdown format. For simple edits, you can directly edit the file on GitHub and generate a Pull Request. If you would like to use an IDE, [Visual Studio](https://visualstudio.microsoft.com/) works well with documentation using VitePress.
 
-## Working on the content
-
-- See VitePress docs on supported [Markdown Extensions](https://vitepress.vuejs.org/guide/markdown.html) and the ability to [use Vue syntax inside markdown](https://vitepress.vuejs.org/guide/using-vue.html).
+Please refer to the [Contributing guide](/.github/contributing.md) for more details.
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 77e398e..6788c86 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -58,31 +58,5 @@ function sidebarGuide() {
         { text: "Token burning", link: "/token-burning" }
       ]
     }
-    // {
-    //   text: "Advanced Usage",
-    //   collapsible: false,
-    //   items: [
-    //     { text: "Tweaking the Input Selector", link: "" },
-    //     { text: "Working with Constants", link: "" }
-    //   ]
-    // },
-    // {
-    //   text: "Built-in Plugins",
-    //   collapsible: false,
-    //   items: [
-    //     { text: "Babel Fees", link: "" },
-    //     { text: "Sigma USD", link: "" },
-    //     { text: "SigmaFi", link: "" }
-    //   ]
-    // },
-    // {
-    //   text: "Plugin Authoring",
-    //   collapsible: false,
-    //   items: [
-    //     { text: "Getting Started", link: "" },
-    //     { text: "API specifications", link: "" },
-    //     { text: "Examples", link: "" }
-    //   ]
-    // }
   ];
 }
diff --git a/docs/getting-started.md b/docs/getting-started.md
index c214df8..d484f21 100644
--- a/docs/getting-started.md
+++ b/docs/getting-started.md
@@ -2,10 +2,6 @@
 
 Fleet SDK is an easy-to-use, modular, and extensible off-chain SDK (Software Development Kit) for the [Ergo Platform](https://ergoplatform.org/en/), written entirely in TypeScript.
 
-::: warning
-**Fleet SDK** is currently in alpha status. It is already suitable for out-of-the-box use, but the API may still change between minor releases.
-:::
-
 ## Step. 1: Install
 
 Add Fleet SDK as a dependency for the project.
diff --git a/package.json b/package.json
index 3348160..c8eaca8 100644
--- a/package.json
+++ b/package.json
@@ -2,11 +2,10 @@
   "name": "docs",
   "version": "1.0.0",
   "description": "",
-  "packageManager": "pnpm@8.0.0",
   "scripts": {
-    "docs:dev": "vitepress dev docs",
-    "docs:build": "vitepress build docs",
-    "docs:preview": "vitepress preview docs"
+    "dev": "vitepress dev docs",
+    "build": "vitepress build docs",
+    "preview": "vitepress preview docs"
   },
   "keywords": [],
   "author": "",