diff --git a/docs/docs/overview/architecture.md b/docs/docs/getting-started/app-anatomy.md similarity index 59% rename from docs/docs/overview/architecture.md rename to docs/docs/getting-started/app-anatomy.md index af63ffe6d..40cc73886 100644 --- a/docs/docs/overview/architecture.md +++ b/docs/docs/getting-started/app-anatomy.md @@ -1,13 +1,16 @@ --- -sidebar_position: 1 -title: Architecture +sidebar_position: 2 +title: Anatomy of an app --- -## Jan overall architecture +## Jan Architecture + ![Overall architecture](img/architecture-1.drawio.png) + - Jan platform includes the following components: + - Processes: - - UI process: + - UI process: - This is Electron framework `renderer` component (Web technology equivalent) - Jan provides core platform UI that: - Allows App to `register()` function blueprint with name and arguments @@ -20,3 +23,18 @@ title: Architecture - `@janhq/core` library that exposes Core API for App to reuse. Currently it only supports App `index.ts` - Vertically, there are `Platform Core` component and `App` component. Each of those includes UI and Node process that work in pair. + +## + +Platform has 3 events that are broadcast to installed Apps +![Platform events](img/app-anatomy-4.drawio.png) + +- onLaunch() + ![Platform onLaunch()](img/app-anatomy-1.drawio.png) +- onStart() + ![Platform onStart()](img/app-anatomy-2.drawio.png) +- onDispose() + ![Platform onDispose()](img/app-anatomy-3.drawio.png) +- At any given time, when there is new App installtion/ unintallation, the Platform restarts and trigger +- When App is being used, here is how the information passes between Platform and Apps + ![Communication](img/app-anatomy-5.drawio.png) diff --git a/docs/docs/getting-started/build-an-app.md b/docs/docs/getting-started/build-an-app.md new file mode 100644 index 000000000..6ede71756 --- /dev/null +++ b/docs/docs/getting-started/build-an-app.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 1 +title: Build an app +--- + +TODO: quickstart tutorial diff --git a/docs/docs/getting-started/development-workflow.md b/docs/docs/getting-started/development-workflow.md new file mode 100644 index 000000000..bb5ef1231 --- /dev/null +++ b/docs/docs/getting-started/development-workflow.md @@ -0,0 +1,6 @@ +--- +sidebar_position: 2 +title: Development workflow +--- + +todo diff --git a/docs/docs/overview/img/app-anatomy-1.drawio.png b/docs/docs/getting-started/img/app-anatomy-1.drawio.png similarity index 100% rename from docs/docs/overview/img/app-anatomy-1.drawio.png rename to docs/docs/getting-started/img/app-anatomy-1.drawio.png diff --git a/docs/docs/overview/img/app-anatomy-2.drawio.png b/docs/docs/getting-started/img/app-anatomy-2.drawio.png similarity index 100% rename from docs/docs/overview/img/app-anatomy-2.drawio.png rename to docs/docs/getting-started/img/app-anatomy-2.drawio.png diff --git a/docs/docs/overview/img/app-anatomy-3.drawio.png b/docs/docs/getting-started/img/app-anatomy-3.drawio.png similarity index 100% rename from docs/docs/overview/img/app-anatomy-3.drawio.png rename to docs/docs/getting-started/img/app-anatomy-3.drawio.png diff --git a/docs/docs/overview/img/app-anatomy-4.drawio.png b/docs/docs/getting-started/img/app-anatomy-4.drawio.png similarity index 100% rename from docs/docs/overview/img/app-anatomy-4.drawio.png rename to docs/docs/getting-started/img/app-anatomy-4.drawio.png diff --git a/docs/docs/overview/img/app-anatomy-5.drawio.png b/docs/docs/getting-started/img/app-anatomy-5.drawio.png similarity index 100% rename from docs/docs/overview/img/app-anatomy-5.drawio.png rename to docs/docs/getting-started/img/app-anatomy-5.drawio.png diff --git a/docs/docs/overview/img/architecture-1.drawio.png b/docs/docs/getting-started/img/architecture-1.drawio.png similarity index 100% rename from docs/docs/overview/img/architecture-1.drawio.png rename to docs/docs/getting-started/img/architecture-1.drawio.png diff --git a/docs/docs/overview/concepts.md b/docs/docs/guides/concepts.md similarity index 94% rename from docs/docs/overview/concepts.md rename to docs/docs/guides/concepts.md index a3b5a1551..5edf9c128 100644 --- a/docs/docs/overview/concepts.md +++ b/docs/docs/guides/concepts.md @@ -1,5 +1,4 @@ --- -sidebar_position: 2 title: Concepts --- diff --git a/docs/docs/overview/app_anatomy.md b/docs/docs/overview/app_anatomy.md deleted file mode 100644 index 82a07191c..000000000 --- a/docs/docs/overview/app_anatomy.md +++ /dev/null @@ -1,17 +0,0 @@ ---- -sidebar_position: 3 -title: App Anatomy ---- - -Platform has 3 events that are broadcast to installed Apps -![Platform events](img/app-anatomy-4.drawio.png) - -- onLaunch() - ![Platform onLaunch()](img/app-anatomy-1.drawio.png) -- onStart() - ![Platform onStart()](img/app-anatomy-2.drawio.png) -- onDispose() - ![Platform onDispose()](img/app-anatomy-3.drawio.png) -- At any given time, when there is new App installtion/ unintallation, the Platform restarts and trigger -- When App is being used, here is how the information passes between Platform and Apps - ![Communication](img/app-anatomy-5.drawio.png) diff --git a/docs/docs/tutorials/build-jan-app.md b/docs/docs/tutorials/build-chat-app.md similarity index 53% rename from docs/docs/tutorials/build-jan-app.md rename to docs/docs/tutorials/build-chat-app.md index 8ed0715fd..5ab6eec6b 100644 --- a/docs/docs/tutorials/build-jan-app.md +++ b/docs/docs/tutorials/build-chat-app.md @@ -1,6 +1,6 @@ --- sidebar_position: 1 -title: How to Build a Jan App +title: Building a chat app --- TODO diff --git a/docs/docs/tutorials/build-rag-app.md b/docs/docs/tutorials/build-rag-app.md index 5c14911e1..a5b54c5f2 100644 --- a/docs/docs/tutorials/build-rag-app.md +++ b/docs/docs/tutorials/build-rag-app.md @@ -1,6 +1,6 @@ --- sidebar_position: 2 -title: How to Build RAG App +title: Building a RAG app --- TODO diff --git a/docs/docs/tutorials/publish-jan-app.md b/docs/docs/tutorials/publish-jan-app.md index d4badf12c..9209be9e4 100644 --- a/docs/docs/tutorials/publish-jan-app.md +++ b/docs/docs/tutorials/publish-jan-app.md @@ -1,6 +1,6 @@ --- sidebar_position: 3 -title: How to Publish a Jan App +title: Publishing a Jan app --- TODO diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js index f55f96a2a..f9f0eb6dc 100644 --- a/docs/docusaurus.config.js +++ b/docs/docusaurus.config.js @@ -117,7 +117,7 @@ const config = { src: "img/logo.svg", }, items: [ - // Navbar Top + // Navbar left // { // type: "docSidebar", // sidebarId: "featuresSidebar", @@ -135,7 +135,7 @@ const config = { type: "docSidebar", sidebarId: "guidesSidebar", position: "right", - label: "Guides", + label: "User Guides", }, { type: "docSidebar", diff --git a/docs/sidebars.js b/docs/sidebars.js index 775d7fe05..a93d3e22d 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -49,13 +49,13 @@ const sidebars = { devSidebar: [ { type: "category", - label: "Overview", + label: "Getting Started", collapsible: true, collapsed: false, items: [ { type: "autogenerated", - dirName: "overview", + dirName: "getting-started", }, ], },