diff --git a/docs/docs/guides/how-jan-works.md b/docs/docs/guides/how-jan-works.md deleted file mode 100644 index c26d060c8..000000000 --- a/docs/docs/guides/how-jan-works.md +++ /dev/null @@ -1,13 +0,0 @@ ---- -title: How Jan Works -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- - -- Local Filesystem - - Follow-on from Quickstart to show how things actually worked - - Write in a conversational style, show how things work under the hood - - Check how filesystem changed after each request -- Model loading into RAM/VRAM - - Explain how the .bin file is loaded via Llama.cpp - - Explain how it consumes RAM and VRAM, and refer to system monitor diff --git a/docs/docs/handbook/engineering/engineering.md b/docs/docs/handbook/engineering.md similarity index 100% rename from docs/docs/handbook/engineering/engineering.md rename to docs/docs/handbook/engineering.md diff --git a/docs/docs/handbook/handbook.md b/docs/docs/handbook/handbook.md deleted file mode 100644 index 7fc5a9138..000000000 --- a/docs/docs/handbook/handbook.md +++ /dev/null @@ -1,72 +0,0 @@ ---- -title: Onboarding Checklist -slug: /handbook -description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. -keywords: [Jan AI, Jan, ChatGPT alternative, local AI, private AI, conversational AI, no-subscription fee, large language model ] ---- - -# 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 - -:::info - -💡 In order to feel connected in a remote workplace, we encourage you to add your profile photo to all the accounts. - -::: - -- 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. diff --git a/docs/docs/handbook/onboarding.md b/docs/docs/handbook/onboarding.md new file mode 100644 index 000000000..e9124bdad --- /dev/null +++ b/docs/docs/handbook/onboarding.md @@ -0,0 +1,77 @@ +--- +title: Onboarding +slug: /handbook +description: Jan is a ChatGPT-alternative that runs on your own computer, with a local API server. +keywords: + [ + Jan AI, + Jan, + ChatGPT alternative, + local AI, + private AI, + conversational AI, + no-subscription fee, + large language model, + ] +--- + +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 operate on the basis of trust. +- We expect you to be available and communicative during scheduled meetings or work hours. +- 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 + +:::info + +💡 In order to feel connected in a remote workplace, we encourage you to add your profile photo to all the accounts. + +::: + +- 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. diff --git a/docs/docs/handbook/product.md b/docs/docs/handbook/product.md new file mode 100644 index 000000000..05cab2a45 --- /dev/null +++ b/docs/docs/handbook/product.md @@ -0,0 +1,42 @@ +--- +title: Product +--- + +We use Github for 100% of our product / project management. + +Projects are defined across the organization. + +As much as possible, everyone owns their respective `epics`, `milestones`. and `tasks`. + +> We aim for a `loosely coupled, but tightly aligned` autonomous PM culture. + +## Projects + +- `Projects` track large, long-term, & strategic initiatives that can span multiple teams and multiple sprints. +- Projects are listed in [Github Projects](https://github.com/janhq/jan/projects?query=is%3Aopen). +- `Projects` contain `epics` + +## Epics && Milestones + +`Epics` + +- `Epics` are large user stories that are then further broken down into tasks. +- `Epics` track the specs, architecture decisions, designs, and what is in scope for large features. +- Every `epic` corresponds with a single `Milestones` +- `Epics` contain `tasks` +- `Epics` should only have 1 owner + +`Milestones` + +- `Milestones` correspond 1:1 to `epics`. +- We use `milestones` to render the correct Roadmap & Kanban views. +- `Milestones` should have a deadline. + +## `Tasks` + +- Tasks are individual features, bug fixes, or chores that can be completed within a few days +- Tasks under `In-progress` and `Todo` should always belong to a `milestone` +- Tasks are usually named per [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/#summary) +- Tasks should only have 1 owner + +We aim to always work on `tasks` that belong to a `milestones`. diff --git a/docs/sidebars.js b/docs/sidebars.js index 51db7fcb8..26c8dd747 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -20,7 +20,7 @@ const sidebars = { link: { type: "doc", id: "guides/introduction" }, collapsible: true, collapsed: true, - items: ["guides/quickstart", "guides/how-jan-works"], + items: ["guides/quickstart"], }, { type: "category", @@ -117,25 +117,22 @@ const sidebars = { label: "About Jan", id: "about/about", }, - { - type: "link", - label: "Careers", - href: "https://janai.bamboohr.com/careers", - }, { type: "category", label: "Company Handbook", collapsible: true, - collapsed: true, - // link: { type: "doc", id: "handbook/handbook" }, + collapsed: false, items: [ - { - type: "doc", - label: "Engineering", - id: "handbook/engineering/engineering", - }, + "handbook/onboarding", + "handbook/engineering", + "handbook/product", ], }, + { + type: "link", + label: "Careers", + href: "https://janai.bamboohr.com/careers", + }, ], };