feat(docs): update readme and docs

.changeset/purple-rice-suffer.md

@@ -0,0 +1,5 @@
+---
+'@lagoss/ui': minor
+---
+
+Updated docs to vitepress, added self-hosting instructions and adjusted README

CODE_OF_CONDUCT.md

@@ -59,8 +59,7 @@ representative at an online or offline event.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported to the community leaders responsible for enforcement at
-[email protected].
+reported to the community leaders responsible for enforcement at lagoss[at]ju60.de.
 All complaints will be reviewed and investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security of the

README.md

@@ -1,14 +1,14 @@
 <p align="center">
   <picture>
-    <source media="(prefers-color-scheme: dark)" srcset="./assets/logo-white.png">
-    <source media="(prefers-color-scheme: light)" srcset="./assets/logo-black.png">
+    <source media="(prefers-color-scheme: dark)" srcset="./assets/icon-white.png">
+    <source media="(prefers-color-scheme: light)" srcset="./assets/icon-black.png">
     <img alt="Lagoss logo" height="60px" src="./assets/logo-white.png">
   </picture>
+  <h1 align="center">Lagoss</h1>
   <p align="center">
     Deploy Serverless Functions at the Edge
     <br />
     <br />
-    <a align="center" href="https://discord.lagoss.com" alt="Discord"><img src="https://img.shields.io/discord/996005154753093713" /></a>
     <a href="https://github.com/lagossapp/lagoss/actions/workflows/wpt.yml" alt="web-platform-tests"><img src="https://wpt.lagoss.com" /></a>
   </p>
 </p>
@@ -19,16 +19,14 @@
 
 ## About
 
-Lagoss is an open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions close to users.
+Lagoss is a fork of [Lagon](https://github.com/lagonapp/lagon) an open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions.
 
-> **Note**: Lagoss is in Alpha. Get access to Lagoss Cloud via the [waitlist](https://tally.so/r/n9q1Rp)
-
-Current status:
-
-- Dev: In heavy development, features are being added and APIs have breaking changes
-- **Alpha**: Missing features and bugs to fix, progressive access to Lagoss Cloud ([waitlist](https://tally.so/r/n9q1Rp))
-- ~Beta~: Stable APIs, last features are being added, Lagoss Cloud available without a waitlist
-- ~General Availability~: Cloud and self-hosted versions available for production usage
+> [!NOTE]
+> The project was forked from [Lagon](https://github.com/lagonapp/lagon) with the
+> intention to continue development. There is currently a public testing instance
+> deployed at <https://app.lagoss.com>. However it should be used for basic
+> testing only and data might be deleted at any point. If you want a proper setup,
+> please deploy your own instance => [Install my own instance](https://docs.lagoss.com/self-hosting/installation).
 
 ## Packages
 
@@ -50,12 +48,6 @@ Current status:
 - CLI to manage Functions and develop locally
 - Deploy at the Edge using the Cloud version, or self-host it
 
-## Roadmap
-
-The roadmap is accessible to anyone on GitHub. Feel free to open an issue to discuss new features that you would like to see implemented.
-
-[See the roadmap on GitHub](https://github.com/orgs/lagossapp/projects/1)
-
 ## Contributing
 
 [See the contributing guide](https://docs.lagoss.com/contributing)
@@ -66,12 +58,10 @@ Lagoss uses V8 Isolates, which are sandboxed environments used to run plain Java
 
 Starting an Isolate is a lot faster than starting a whole Node.js process, which allows for almost free cold starts.
 
-## Sponsors ❤️
-
-Thanks a lot to every current and past sponsor!
+## Installation
 
-![Sponsors list](./assets/sponsors.png)
+Learn how you can [install](https://docs.lagoss.com/self-hosting/installation) your own Lagoss instance.
 
 ## License
 
-[GNU AGPLv3](./LICENSE)
+[GNU AGPLv3](./LICENSE)

packages/dashboard/locales/en.ts

@@ -83,7 +83,7 @@ export default {
   'settings.transfer.success': 'Ownership of this Organization transferred successfully.',
   'settings.transfer.notAvailable': 'Not available yet.',
   'settings.transfer.notAvailable.description':
-    'Please email [email protected] if you want to transfer your Organization.',
+    'Please email lagoss[at]ju60.de if you want to transfer your Organization.',
 
   'settings.usage.title': 'Usage',
   'settings.usage.description':
@@ -133,7 +133,7 @@ export default {
   'profile.delete.modal.confirm': 'Confirm with your email',
   'profile.delete.modal.submit': 'Delete Account',
   'profile.delete.notAvailable': 'Not available yet.',
-  'profile.delete.notAvailable.description': 'Please email [email protected] if you want to delete your Account.',
+  'profile.delete.notAvailable.description': 'Please email lagoss[at]ju60.de if you want to delete your Account.',
 
   'cli.title': 'Log in to the CLI',
   'cli.description': 'This is your verification code to login in the CLI. Copy it and paste it in your terminal.',

packages/dashboard/locales/fr.ts

@@ -87,7 +87,7 @@ export default defineLocale({
   'settings.transfer.success': "La propriété de l'Organisation a été transférée.",
   'settings.transfer.notAvailable': 'Non disponible.',
   'settings.transfer.notAvailable.description':
-    "Merci d'envoyer un email à [email protected] si vous voulez transférer votre Organisation.",
+    "Merci d'envoyer un email à lagoss[at]ju60.de si vous voulez transférer votre Organisation.",
 
   'settings.usage.title': 'Utilisation',
   'settings.usage.description':
@@ -139,7 +139,7 @@ export default defineLocale({
   'profile.delete.modal.submit': 'Supprimer ce Compte',
   'profile.delete.notAvailable': 'Non disponible.',
   'profile.delete.notAvailable.description':
-    "Merci d'envoyer un email à [email protected] si vous voulez supprimer votre Compte.",
+    "Merci d'envoyer un email à lagoss[at]ju60.de si vous voulez supprimer votre Compte.",
 
   'cli.title': 'Connexion à la CLI',
   'cli.description':

packages/docs/.gitignore

@@ -1,36 +1,3 @@
-# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
-
-# dependencies
-/node_modules
-/.pnp
-.pnp.js
-
-# testing
-/coverage
-
-# next.js
-/.next/
-/out/
-
-# production
-/build
-
-# misc
-.DS_Store
-*.pem
-
-# debug
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-.pnpm-debug.log*
-
-# local env files
-.env*.local
-
-# vercel
-.vercel
-
-# typescript
-*.tsbuildinfo
-next-env.d.ts
+.vitepress/cache/
+.vitepress/build/
+node_modules/

packages/docs/.vitepress/config.ts

@@ -0,0 +1,74 @@
+import { defineConfig } from 'vitepress';
+
+// https://vitepress.dev/reference/site-config
+export default defineConfig({
+  title: 'Lagoss',
+  description:
+    'An open-source runtime and platform that allows developers to run TypeScript and JavaScript Serverless Functions.',
+
+  srcDir: 'content',
+
+  ignoreDeadLinks: [
+    // ignore all localhost links
+    /^https?:\/\/localhost/,
+  ],
+
+  themeConfig: {
+    logo: '/icon-white.png',
+
+    nav: [
+      { text: 'Home', link: '/' },
+      { text: 'Docs', link: '/introduction' },
+      { text: 'Dashboard', link: 'https://app.lagoss.com' },
+    ],
+
+    sidebar: [
+      {
+        text: 'Introduction',
+        link: '/introduction',
+      },
+      {
+        text: 'Getting Started',
+        link: '/getting-started',
+      },
+      {
+        text: 'Runtime APIs',
+        link: '/runtime-apis',
+      },
+      {
+        text: 'CLI',
+        link: '/cli',
+      },
+      {
+        text: 'Examples',
+        link: '/examples',
+      },
+      {
+        text: 'Usage',
+        collapsed: false,
+        items: [
+          { text: 'Deployments', link: '/usage/deployments' },
+          { text: 'Assets', link: '/usage/assets' },
+          { text: 'Environment variables', link: '/usage/environment-variables' },
+          { text: 'Domains', link: '/usage/domains' },
+          { text: 'Logs', link: '/usage/logs' },
+          { text: 'Cron', link: '/usage/cron' },
+          // { text: 'Pricing', link: '/usage/pricing' },
+          // { text: 'Regions', link: '/usage/regions' },
+          { text: 'Limits', link: '/usage/limits' },
+          { text: 'Security', link: '/usage/security' },
+        ],
+      },
+      {
+        text: 'Self hosting',
+        collapsed: true,
+        items: [
+          { text: 'Installation', link: '/self-hosting/installation' },
+          { text: 'Configuration', link: '/self-hosting/configuration' },
+        ],
+      },
+    ],
+
+    socialLinks: [{ icon: 'github', link: 'https://github.com/lagossapp/lagoss' }],
+  },
+});

packages/docs/.vitepress/lagoss.ts

@@ -0,0 +1,8 @@
+export function handler(request: Request) {
+  return new Response('', {
+    status: 302,
+    headers: {
+      location: '/404.html',
+    },
+  });
+}