Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Updated documentation #122

Merged
merged 6 commits into from
Mar 3, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
7,044 changes: 4,233 additions & 2,811 deletions package-lock.json

Large diffs are not rendered by default.

45 changes: 12 additions & 33 deletions websites/docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -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" }],
Expand All @@ -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",
Expand Down
2 changes: 1 addition & 1 deletion websites/docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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",
Expand Down
Loading
Loading