Merge branch 'main' into docs/install-succinct

.github/ISSUE_TEMPLATE/documentation-request.md

@@ -0,0 +1,17 @@
+---
+name: Documentation request
+about: Documentation requests
+title: 'docs: TITLE'
+labels: 'type: documentation'
+assignees: ''
+
+---
+
+**Pages**
+- Page(s) that need to be done
+
+**Success Criteria**
+Content that should be covered
+
+**Additional context**
+Examples, reference pages, resources

.github/workflows/jan-docs.yml

@@ -6,6 +6,7 @@ on:
       - main
     paths:
       - 'docs/**'
+    tags: ["v[0-9]+.[0-9]+.[0-9]+-docs"]
   pull_request:
     branches:
       - main
@@ -18,7 +19,14 @@ on:
 jobs:
   deploy:
     name: Deploy to GitHub Pages
+    env:
+      CLOUDFLARE_ACCOUNT_ID: 9707100ef42a1a25bd70e3ee2137bd0e
+      CLOUDFLARE_PROJECT_NAME: jan
     runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      deployments: write
+      pull-requests: write
     steps:
       - uses: actions/checkout@v3
       - uses: actions/setup-node@v3
@@ -50,15 +58,33 @@ jobs:
       - name: Build website
         run: sed -i '/process.env.DEBUG = namespaces;/c\// process.env.DEBUG = namespaces;' ./node_modules/debug/src/node.js && yarn build
         working-directory: docs
-
+
+      - name: Publish to Cloudflare Pages PR Preview and Staging
+        if: (github.event_name == 'push' && github.ref == 'refs/heads/main') || (github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main')
+        uses: cloudflare/pages-action@v1
+        with:
+          apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }}
+          accountId: ${{ env.CLOUDFLARE_ACCOUNT_ID }}
+          projectName: ${{ env.CLOUDFLARE_PROJECT_NAME }}
+          directory: ./docs/build
+          # Optional: Enable this if you want to have GitHub Deployments triggered
+          gitHubToken: ${{ secrets.GITHUB_TOKEN }}
+        id: deployCloudflarePages
+
+      - uses: mshick/add-pr-comment@v2
+        if: github.event_name == 'pull_request' && github.event.pull_request.base.ref == 'main'
+        with:
+          message: |
+              Preview URL: ${{ steps.deployCloudflarePages.outputs.url }}
+
       - name: Add Custome Domain file
-        if: github.event_name == 'push' && github.event.pull_request.head.repo.full_name != github.repository
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
         run: echo "${{ vars.DOCUSAURUS_DOMAIN }}" > ./docs/build/CNAME
 
       # Popular action to deploy to GitHub Pages:
       # Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
       - name: Deploy to GitHub Pages
-        if: github.event_name == 'push' && github.event.pull_request.head.repo.full_name != github.repository
+        if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/')
         uses: peaceiris/actions-gh-pages@v3
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/jan-electron-build.yml

@@ -2,7 +2,7 @@ name: Jan Build Electron App
 
 on:
   push:
-    tags: ["v*.*.*"]
+    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
 
 jobs:
   build-macos:

docs/README.md

@@ -41,6 +41,12 @@ $ 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.
 
+### Preview URL, Pre-release and Publishing Documentation
+
+When a PR is created, the preview URL will be automatically commented on the PR. For staging or pre-release documentation, use the following domains [https://pre-release.jan.ai/](https://pre-release.jan.ai/)
+
+To officially publish documentation, create a tag in the format `vx.y.z-docs` (e.g., `v0.1.1-docs`) on the `main` branch. The documentation will then be published to [https://jan.ai/](https://jan.ai/)
+
 ### Additional Plugins
 - @docusaurus/theme-live-codeblock
 - [Redocusaurus](https://redocusaurus.vercel.app/): manually upload swagger files at `/openapi/OpenAPISpec.json`

docs/docs/handbook/handbook.md

@@ -1,5 +1,72 @@
 ---
-title: Company Handbook
+title: Onboarding Checklist
 slug: /handbook
 ---
 
+
+# Welcome
+
+Welcome to Jan! We’re really excited to bring you onboard.
+
+## Expectations
+
+
+**Take Initiative**  Take ownership of an area. If you see a problem, take it and own it to completion. Your work will often not be defined, or poorly defined. Take the initiative to figure out what needs to be done, seek others out for clarification, and then communicate what you will be doing to the team.
+
+ **Bias to Action** There are many problem-filled areas. There is no need to ask for permission or try to build consensus: just take action.   
+
+**Speak Up** We require clear, effective and timely communication, which enables others to coordinate with you to be effective.  We are a fully distributed, remote team of people from different cultures and languages. If conflicts do arise, first assume Hanlon’s Razor: “Never attribute to malice that which is adequately explained by ~~stupidity~~ lack of communication or too much ambiguity”. Don’t take things personally, be a professional. 
+
+**Mastery** We are working in a frontier industry, where there are no playbooks, and expertise is developed by doing. Own your area, and build mastery.
+
+
+## Code of conduct
+
+-   We expected you to be available and communicative during scheduled meetings or work hours.
+-   We operate on the basis of trust.
+-   Employees should seek a quiet and distraction-free working space, to the extent possible.
+-   Turning on video during meetings is encouraged.
+-   Casual dress during meetings is acceptable; however, use discretion (No naked top, pajamas, etc.)
+-   While it’s natural for people to disagree at times, disagreement is no excuse for poor behavior and poor manners. We cannot allow that frustration to turn into a personal attack.
+-   Respect other people's cultures. Especially since we are working in a diverse working culture.
+-   Sexual harassment is a specific type of prohibited conduct. Sexual harassment is any unwelcome conduct of a sexual nature that might reasonably be expected or be perceived to cause offense or humiliation. Sexual harassment may involve any conduct of a verbal, nonverbal, or physical nature, including written and electronic communications, and may occur between persons of the same or different genders.
+
+## Onboarding Checklist
+
+### HR
+
+-   [ ] Service Agreement
+-   [ ] Equipment Loan Agreement
+-   [ ]  Calendar events
+    -   [ ] Add to Google Team 
+    -   [ ] Add to Standup & TGIF
+-   [ ] `#hr-*` channel
+-   [ ] BambooHr Log-in
+-   [ ] Add Emergency Contact in BambooHR 
+
+### Apps you will need
+
+<aside> 💡 In order to feel connected in a remote workplace, we encourage you to add your profile photo to all the accounts.
+
+</aside>
+
+-   Company-wide
+    -   [ ] Google:`[first_name]@jan.ai`
+        -   Recommended: setup on Mobile too (i.e. Calendar, Mail)
+        -   We use Google Calendar for tracking meetings, etc. 
+    -   [ ] Discord:
+        -   [Invite link](https://discord.gg/sZb6qxfgyx) to Jan’s Discord
+        -   We use Discord for day-to-day Comms in the company (ala Slack)
+        -   Recommended: setup on Mobile with Notifications
+        -   Download the desktop app
+    -   [ ] 1Password
+    -   [ ] [Jan](https://jan.ai/) - Desktop App
+-   Engineering
+    -   [ ] Code Editor (such as VSCode, Vim, ect)
+    -   [ ] Github
+-   Communications
+    -   [ ] Fill in your contact details [here](https://docs.google.com/spreadsheets/d/1KAxya29_wb1bEESiFJeCrOec4pCG3uA2D4_VPgAn89U/edit#gid=0)
+    -   [ ] To make sure everyone in the remote working environment understand more about each other, we encourage you to share your `How to work with me` in the [Drive Tab](https://docs.google.com/spreadsheets/d/1KAxya29_wb1bEESiFJeCrOec4pCG3uA2D4_VPgAn89U/edit#gid=0) under your name and the Discord `Internal` channel. 
+
+:::info UPDATING
+:::