Docusarus website with automated workflow

.github/workflows/docusarus.yml

@@ -0,0 +1,50 @@
+name: Deploy Docs to GitHub Pages
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'docs/**' # Only trigger on changes in docs directory
+
+jobs:
+  build:
+    name: Build Docusaurus
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 18
+          cache: npm
+          cache-dependency-path: docs/package-lock.json # Specify path to lock file
+
+      - name: Install dependencies
+        run: npm install --frozen-lockfile
+        working-directory: docs # Set working directory to docs folder
+
+      - name: Build website
+        run: npm run build
+        working-directory: docs # Set working directory to docs folder
+
+      - name: Upload Build Artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs/build # Update build output path
+
+  deploy:
+    name: Deploy to GitHub Pages
+    needs: build
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

docs/.gitignore

@@ -0,0 +1,20 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

docs/README.md

@@ -0,0 +1,41 @@
+# Website
+
+This website is built using [Docusaurus](https://docusaurus.io/), a modern static website generator.
+
+### Installation
+
+```
+$ yarn
+```
+
+### Local Development
+
+```
+$ yarn start
+```
+
+This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
+
+### Build
+
+```
+$ yarn build
+```
+
+This command generates static content into the `build` directory and can be served using any static contents hosting service.
+
+### Deployment
+
+Using SSH:
+
+```
+$ USE_SSH=true yarn deploy
+```
+
+Not using SSH:
+
+```
+$ GIT_USER=<Your GitHub username> yarn deploy
+```
+
+If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.

docs/docs/contributing/architecture.md

@@ -0,0 +1,12 @@
+---
+sidebar_position: 1
+---
+
+# Architecture
+
+[more details later]
+
+archi/v1 is as follows :
+
+![architecture](https://github.com/user-attachments/assets/b2d8b70e-7a6d-45c9-a706-0cf955d13451)
+

docs/docs/contributing/todo.md

@@ -0,0 +1,54 @@
+---
+---
+
+# Todo 
+
+A non-ordered roadmap & todo dump
+will update with proper map later, ignore for now
+
+---
+
+## nearest
+merge with browser-based local dev env using webcontainers ; console.cofounder.openinterface.ai
+
+## validation, errorfix
+post-generation validation swarm modules
+swarm autofix modules, merge
+babel parse
+
+## build, deploy
+vite plugin to generate web app without the cofounder modules
+generate packed projects ready for deployment
+automate deployments, integrate different services
+
+## design, layouts
+plug in advanced designer + models
+document how to custom design systems
+add & index docs for shiny design systems
+fonts / css modules
+release extensive cofounder index on api access for layout designer to use
+separate desktop,mobile in designer
+RAG on icons via text/clip (like in openv0), maybe as a vite plugin
+
+## functional
+deploy latest index checkpoint in api.cofounder
+
+## mgmt
+more iteration modules, sequences to handle full lifecycle of generated projects
+document everything
+
+## platforms
+react-native / flutter
+more frontend frameworks
+
+## project
+technical articles
+model train & serve from api
+admin panel à la coolify
+
+## also
+SEO stuff
+analytics into the dev feedback
+animation (ie. framer-motion)
+functional, api, python support api-side
+benchmarks

docs/docs/generated-apps.md

@@ -0,0 +1,80 @@
+---
+sidebar_position: 4
+---
+
+# Run Generated Apps
+
+- Your backend & vite+react web app will incrementally generate inside `./apps/{YourApp}`
+Open your terminal in `./apps/{YourApp}` and run
+
+```sh
+npm i && npm run dev
+```
+
+It will start both the backend and vite+react, concurrently, after installing their dependencies
+Go to `http://localhost:5173/` to open the web app 🎉
+
+
+- From within the generated apps , you can use ⌘+K / Ctrl+K to iterate on UI components
+
+[more details later]
+
+## Notes
+
+### Dashboard & Local API
+
+If you resume later and would like to iterate on your generated apps,
+the local `./cofounder/api` server needs to be running to receive queries
+
+You can (re)start the `local cofounder API` running the following command from `./cofounder/api`
+
+```sh
+npm run start
+```
+
+The dashboard will open in `http://localhost:4200`
+
+
+- note: You can also generate new apps from the same env, without the the dashboard, by running, from `./cofounder/api`, one of these commands
+
+    ```sh
+    npm run start -- -p "ProjectName" -f "some app description" -a "minimalist and spacious , light theme"
+    npm run start -- -p "ProjectName" -f "./example_description.txt" -a "minimalist and spacious , light theme"
+    ```
+
+### Concurrency
+
+**[the architecture will be further detailed and documented later]**
+
+Every "node" in the `cofounder` architecture has a defined configuration under `./cofounder/api/system/structure/nodes/{category}/{name}.yaml` to handle things like concurrency, retries and limits per time interval
+
+For example, if you want multiple LLM generations to run in parallel (when possible - sequences and parallels are defined in DAGS under `./cofounder/api/system/structure/sequences/{definition}.yaml` ),
+go to
+
+```yaml
+#./cofounder/api/system/structure/nodes/op/llm.yaml
+nodes:
+ op:LLM::GEN:
+  desc: "..."
+  in: [model, messages, preparser, parser, query, stream]
+  out: [generated, usage]
+  queue:
+   concurrency: 1 # <------------------------------- here 
+ op:LLM::VECTORIZE:
+  desc: "{texts} -> {vectors}"
+  in: [texts]
+  out: [vectors, usage]
+ mapreduce: true
+ op:LLM::VECTORIZE:CHUNK:
+  desc: "{texts} -> {vectors}"
+  in: [texts]
+  out: [vectors, usage]
+  queue:
+   concurrency: 50
+```
+
+and change the `op:LLM::GEN` parameter `concurrency` to a higher value
+
+The default LLM concurrency is set to `2` so you can see what's happening in your console streams step by step - but you can increment it depending on your api keys limits
+
+---

docs/docs/intro.md

@@ -0,0 +1,53 @@
+---
+sidebar_position: 1
+---
+
+
+# Introduction
+**Early alpha release**
+
+- full stack generative web apps ; backend + db + stateful web apps
+- gen ui rooted in app architecture, with ai-guided mockup designer & modular design systems
+
+---
+
+# Early Alpha : Unstable
+
+The following points are very emphasized :
+
+- This is an EARLY, UNSTABLE, PREVIEW RELEASE of the project. ⚠️ Until v1 is released, it is expected to break often. 
+- **It consumes a lot of tokens**. If you are on a tokens budget, wait until v1 is released.
+- Again, this is an early, unstable release. A first test run. An early preview of the project's ideas. Far from completion. **Open-source iterative development**. Work in progress. Unstable early alpha release. [etc]
+
+**If any of these might be issues for you, even in the slightest way, wait until v1 is released !**
+
+
+---
+
+
+https://github.com/user-attachments/assets/cfd09250-d21e-49fc-a29b-fa0c661abfc0
+
+https://github.com/user-attachments/assets/c055f9c4-6bc0-4b11-ba8f-cc9f149387fa
+
+---
+
+## Important
+
+**Early alpha release ; earlier than expected by 5/6 weeks**
+
+Still not merged with key target features of the project, notably :
+- project iteration modules for all dimensions of generated projects
+- admin interface for event streams and (deeper) project iterations
+- integrate the full genUI plugin :
+  * generative design systems
+  * deploy finetuned models & serve from api.cofounder
+- local, browser-based dev env for the entire project scope
+- add react-native , flutter , other web frameworks 
+- validations & swarm code review and autofix
+- code optimization
+- [...]
+
+be patient :)
+
+---
+

docs/docs/usage.md

@@ -0,0 +1,39 @@
+---
+sidebar_position: 2
+---
+
+# Usage
+
+## Install & Init
+
+* Open your terminal and run
+
+```sh
+npx @openinterface/cofounder
+```
+
+Follow the instructions. The installer 
+- will ask you for your keys
+- setup dirs & start installs
+- will start the local `cofounder/api` builder and server
+- will open the web dashboard where you can create new projects (at `http://localhost:4200` ) 🎉
+
+```
+note :
+you will be asked for a cofounder.openinterface.ai key
+it is recommended to use one as it enables the designer/layoutv1 and swarm/external-apis features
+and can be used without limits during the current early alpha period
+
+the full index will be available for local download on v1 release
+```
+
+- currently using `node v22` for the whole project. 
+
+
+
+```sh
+# alternatively, you can make a new project without going through the dashboard
+# by runing :
+npx @openinterface/cofounder -p "YourAppProjectName" -d "describe your app here" -a "(optional) design instructions"
+```
+