Merge branch 'main' of github.com:holochain/syn

docs/.vitepress/config.mts

@@ -2,14 +2,14 @@ import { defineConfig } from 'vitepress';
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
-  title: 'Syn: real-time editing shared state hApps',
+  title: 'Syn: real-time shared state for hApps',
   description: 'Documentation for the syn holochain engine',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Introduction', link: '/welcome-to-syn' },
-      { text: 'Guides', link: '/building-a-simple-kanban-board-app' },
+      { text: 'Guides', link: '/guides/setup' },
       { text: 'API', link: '/api/syn-store' },
     ],
 
@@ -25,17 +25,21 @@ export default defineConfig({
       {
         text: 'Guides',
         items: [
+          {
+            text: 'Getting ready to buld a syn hApp',
+            link: '/guides/setup',
+          },
           {
             text: 'Building a simple kanban board app',
-            link: '/building-a-simple-kanban-board-app',
+            link: '/guides/building-a-simple-kanban-board-app',
           },
           {
             text: 'Building an app with ephemeral state',
-            link: '/markdown-examples',
+            link: '/guides/building-an-ephemeral-state-app',
           },
           {
             text: 'Building an app with text editors',
-            link: '/markdown-examples',
+            link: '/guides/building-app-with-text-editors',
           },
         ],
       },

docs/guides/building-a-simple-kanban-board-app.md

@@ -1,2 +1,3 @@
 # Building a simple kanban board app
 
+TBD

docs/guides/building-an-ephemeral-state-app.md

@@ -0,0 +1,3 @@
+# Building an ephemeral state app
+
+TBD

docs/guides/building-app-with-text-editors.md

@@ -0,0 +1,3 @@
+# Building an app with text editors
+
+TBD

docs/guides/setup.md

@@ -0,0 +1,15 @@
+# Setting Up A Syn hApp
+
+## Assumptions
+
+These guides assume that:
+  1.  you have little to zero Holochain experience, i.e. this may be your first Holochain app ever!
+  2.  but, that you are quite familiar with JavaScript front-end development
+
+## Installing Holochain Dev Environment
+
+The first step is to install [the Holochain developer environment](https://developer.holochain.org/get-started/).  Please follow step 2!
+
+## Preparing A Syn App
+
+TBD use a template github repo

docs/index.md

@@ -3,23 +3,28 @@
 layout: home
 
 hero:
-  name: "Syn: real-time editing shared state hApps"
-  text: "Documentation for the syn holochain engine"
-  tagline: My great project tagline
+  name: "Syn"
+  text: ""
+  tagline: Real-time shared state for Holochain hApps
   actions:
     - theme: brand
-      text: Markdown Examples
-      link: /markdown-examples
+      text: Introduction
+      link: /welcome-to-syn
     - theme: alt
-      text: API Examples
-      link: /api-examples
+      text: Quickstart
+      link: /quickstart
+    - theme: alt
+      text: Design
+      link: /design
 
 features:
-  - title: Feature A
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature B
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
-  - title: Feature C
-    details: Lorem ipsum dolor sit amet, consectetur adipiscing elit
+  - title: Simple
+    details: Just mutate a javascript object, and syn takes care of everything else
+  - title: Agent Aware
+    details: Know participant's on/offline status, and who's participated in state changes
+  - title: Ephemeral State
+    details: Implement "cursor" positions and other non-committed data for great UX
+  - title: Reactive
+    details: Deep plumbing for reactive-friendly implementations
 ---
 

docs/quickstart.md

@@ -1,5 +1,12 @@
 # Quickstart
 
+
+## Installation
+::: warning
+This quickstart assumes you are allready familiar with Holochain hApp develpment.  If this is your first time building a Holochain
+hApp you probably want to start with one of our [guides](/guides/setup)!
+:::
+
 ## Initialization
 
 You can initialize a new document like this:

docs/welcome-to-syn.md

@@ -6,4 +6,4 @@ Syn is a real-time shared-state engine for holochain. With syn, you can build co
 
 - Go to [design](/design) to get a conceptual overview of the design for syn.
 
-- Go to [building a simple kanban board app](/guides/building-a-simple-kanban-board-app) if you want a more detailed guide on how to build syn apps.
+- Go to [guides](/guides/setup) if you want a more detailed guide on how to build syn apps.