Merge pull request #122 from pufflyai/new-documentation

Updated documentation
pufflyai · Mar 3, 2024 · 5169e9f · 5169e9f
2 parents 92bd971 + dcf7c6b
commit 5169e9f
Show file tree

Hide file tree

Showing 67 changed files with 4,539 additions and 3,589 deletions.
diff --git a/README.md b/README.md
@@ -18,7 +18,11 @@ This is a monorepo managed using [lerna](https://lerna.js.org/)
 
 ### Install dependencies
 
-From the root of the repo, run `yarn install`.
+From the root of the repo, run `npm install`.
+
+### To launch documentation
+
+From the websites/docs folder run  `npm start`.
 
 ### Build all packages
 

diff --git a/package-lock.json b/package-lock.json
diff --git a/websites/docs/.vitepress/config.mts b/websites/docs/.vitepress/config.mts
@@ -23,39 +23,26 @@ export default defineConfig({
     ],
     sidebar: [
       { text: "Introduction", link: "/" },
-      // {
-      //   text: "Guides",
-      //   items: [{ text: "Getting Started", link: "/guides/getting-started" }],
-      // },
       {
-        text: "Concepts",
-        items: [
-          { text: "Tools", link: "/concepts/tools" },
-          { text: "Instructions", link: "/concepts/instructions" },
-          { text: "Prompts", link: "/concepts/prompts" },
-          { text: "LLMs", link: "/concepts/llms" },
-          { text: "Files", link: "/concepts/file" },
-          { text: "Knowledge Bases", link: "/concepts/knowledge-base" },
-        ],
-      },
-      {
-        text: "Nodes",
+        text: "Guides",
         items: [
-          { text: "File", link: "/nodes/file" },
-          { text: "Template", link: "/nodes/template" },
-          { text: "Instruction", link: "/nodes/instruction" },
-          { text: "Checklist", link: "/nodes/table" },
+          { text: "Run your Instructions", link: "/recipes/run" },
+          { text: "Preview your Recipe", link: "/recipes/preview" },
+          { text: "Deploy your Recipe", link: "/recipes/deploy" },
         ],
       },
       {
-        text: "Guides",
+        text: "Concepts",
         items: [
-          { text: "Introduction", link: "/tools/introduction" },
-          { text: "Run your Tool", link: "/tools/run" },
-          { text: "Preview your Tool", link: "/tools/preview" },
-          { text: "Deploy your Tool", link: "/tools/deploy" },
+          { text: "Recipes", link: "/concepts/recipe" },
+          { text: "Instructions", link: "/concepts/instructions" },
+          { text: "Prompts", link: "/concepts/prompts" },
+          { text: "Files", link: "/concepts/file" },
+          { text: "Preview", link: "/concepts/preview" },
+          { text: "Scenarios", link: "/concepts/scenarios" },
         ],
       },
+      { text: "FAQs", link: "/faq.md" },
       {
         text: "SDKs",
         items: [{ text: "Javascript", link: "/sdk/js" }],
@@ -67,14 +54,6 @@ export default defineConfig({
           { text: "Run a Workflow", link: "/api/run-flow" },
         ],
       },
-      {
-        text: "Packages",
-        items: [
-          { text: "@pufflig/ps-chains", link: "/@pufflig/ps-chains" },
-          { text: "@pufflig/ps-nodes", link: "/@pufflig/ps-nodes" },
-          { text: "@pufflig/ps-node-configs", link: "/@pufflig/ps-node-configs" },
-        ],
-      },
       {
         text: "Changelog",
         link: "/changelog",

diff --git a/websites/docs/package.json b/websites/docs/package.json
@@ -5,7 +5,7 @@
   "main": "index.js",
   "license": "MIT",
   "devDependencies": {
-    "vitepress": "1.0.0-rc.31"
+    "vitepress": "1.0.0-rc.44"
   },
   "scripts": {
     "start": "vitepress dev",