@@ -38,8 +38,8 @@ password: Applecar2025
```
See also:
-🚀 [Self-hosting](https://docs.twenty.com/start/self-hosting/)
-🖥️ [Local Setup](https://docs.twenty.com/start/local-setup)
+🚀 [Self-hosting](https://twenty.com/developers/section/self-hosting)
+🖥️ [Local Setup](https://twenty.com/developers/local-setup)
# Why Choose Twenty?
We understand that the CRM landscape is vast. So why should you choose us?
diff --git a/packages/twenty-docs/.gitignore b/packages/twenty-docs/.gitignore
deleted file mode 100644
index bcf1e57c0..000000000
--- a/packages/twenty-docs/.gitignore
+++ /dev/null
@@ -1,22 +0,0 @@
-# Dependencies
-/node_modules
-
-# Production
-/build
-
-# Generated files
-.docusaurus
-.cache-loader
-
-# Misc
-.DS_Store
-.env.local
-.env.development.local
-.env.test.local
-.env.production.local
-
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-
-package-lock.json
\ No newline at end of file
diff --git a/packages/twenty-docs/README.md b/packages/twenty-docs/README.md
deleted file mode 100644
index a3d87f560..000000000
--- a/packages/twenty-docs/README.md
+++ /dev/null
@@ -1,5 +0,0 @@
-# Documentation
-
-The docs here are managed through [Docusaurus 2](https://docusaurus.io/).
-
-We recommend you go directly to the [statically generated website](https://docs.twenty.com) rather than read them here.
\ No newline at end of file
diff --git a/packages/twenty-docs/babel.config.js b/packages/twenty-docs/babel.config.js
deleted file mode 100644
index e00595dae..000000000
--- a/packages/twenty-docs/babel.config.js
+++ /dev/null
@@ -1,3 +0,0 @@
-module.exports = {
- presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
-};
diff --git a/packages/twenty-docs/docs/contributor/_category_.json b/packages/twenty-docs/docs/contributor/_category_.json
deleted file mode 100644
index e12f1ce53..000000000
--- a/packages/twenty-docs/docs/contributor/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Contributing",
- "position": 3
-}
diff --git a/packages/twenty-docs/docs/contributor/bug-and-requests.mdx b/packages/twenty-docs/docs/contributor/bug-and-requests.mdx
deleted file mode 100644
index 63d022f4a..000000000
--- a/packages/twenty-docs/docs/contributor/bug-and-requests.mdx
+++ /dev/null
@@ -1,15 +0,0 @@
----
-title: Bugs and Requests
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbBug
----
-
-## Reporting Bugs
-To report a bug, please [create an issue on GitHub](https://github.com/twentyhq/twenty/issues/new).
-
-You can also ask for help on [Discord](https://discord.gg/cx5n4Jzs57).
-
-## Feature Requests
-
-If you're not sure it's a bug and you feel it's closer to a feature request, then you should probably [open a discussion instead](https://github.com/twentyhq/twenty/discussions/new).
diff --git a/packages/twenty-docs/docs/contributor/frontend/_category_.json b/packages/twenty-docs/docs/contributor/frontend/_category_.json
deleted file mode 100644
index 254ec2489..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/_category_.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "position": 3,
- "collapsible": true,
- "collapsed": true
-}
diff --git a/packages/twenty-docs/docs/contributor/frontend/best-practices.mdx b/packages/twenty-docs/docs/contributor/frontend/best-practices.mdx
deleted file mode 100644
index a4b91b95b..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/best-practices.mdx
+++ /dev/null
@@ -1,330 +0,0 @@
----
-title: Best Practices
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbChecklist
----
-
-This document outlines the best practices you should follow when working on the frontend.
-
-## State management
-
-React and Recoil handle state management in the codebase.
-
-### Use `useRecoilState` to store state
-
-It's good practice to create as many atoms as you need to store your state.
-
-:::tip
-
-It's better to use extra atoms than trying to be too concise with props drilling.
-
-:::
-
-```tsx
-export const myAtomState = atom({
- key: 'myAtomState',
- default: 'default value',
-});
-
-export const MyComponent = () => {
- const [myAtom, setMyAtom] = useRecoilState(myAtomState);
-
- return (
-
- setMyAtom(e.target.value)}
- />
-
- );
-}
-```
-
-### Do not use `useRef` to store state
-
-Avoid using `useRef` to store state.
-
-If you want to store state, you should use `useState` or `useRecoilState`.
-
-See [how to manage re-renders](#managing-re-renders) if you feel like you need `useRef` to prevent some re-renders from happening.
-
-## Managing re-renders
-
-Re-renders can be hard to manage in React.
-
-Here are some rules to follow to avoid unnecessary re-renders.
-
-Keep in mind that you can **always** avoid re-renders by understanding their cause.
-
-### Work at the root level
-
-Avoiding re-renders in new features is now made easy by eliminating them at the root level.
-
-The `PageChangeEffect` sidecar component contains just one `useEffect` that holds all the logic to execute on a page change.
-
-That way you know that there's just one place that can trigger a re-render.
-
-### Always think twice before adding `useEffect` in your codebase
-
-Re-renders are often caused by unnecessary `useEffect`.
-
-You should think whether you need `useEffect`, or if you can move the logic in a event handler function.
-
-You'll find it generally easy to move the logic in a `handleClick` or `handleChange` function.
-
-You can also find them in libraries like Apollo: `onCompleted`, `onError`, etc.
-
-### Use a sibling component to extract `useEffect` or data fetching logic
-
-If you feel like you need to add a `useEffect` in your root component, you should consider extracting it in a sidecar component.
-
-You can apply the same for data fetching logic, with Apollo hooks.
-
-```tsx
-// ❌ Bad, will cause re-renders even if data is not changing,
-// because useEffect needs to be re-evaluated
-export const PageComponent = () => {
- const [data, setData] = useRecoilState(dataState);
- const [someDependency] = useRecoilState(someDependencyState);
-
- useEffect(() => {
- if(someDependency !== data) {
- setData(someDependency);
- }
- }, [someDependency]);
-
- return
{data}
;
-};
-
-export const App = () => (
-
-
-
-);
-```
-
-```tsx
-// ✅ Good, will not cause re-renders if data is not changing,
-// because useEffect is re-evaluated in another sibling component
-export const PageComponent = () => {
- const [data, setData] = useRecoilState(dataState);
-
- return
{data}
;
-};
-
-export const PageData = () => {
- const [data, setData] = useRecoilState(dataState);
- const [someDependency] = useRecoilState(someDependencyState);
-
- useEffect(() => {
- if(someDependency !== data) {
- setData(someDependency);
- }
- }, [someDependency]);
-
- return <>;
-};
-
-export const App = () => (
-
-
-
-
-);
-```
-
-### Use recoil family states and recoil family selectors
-
-Recoil family states and selectors are a great way to avoid re-renders.
-
-They are useful when you need to store a list of items.
-
-### You shouldn't use `React.memo(MyComponent)`
-
-Avoid using `React.memo()` because it does not solve the cause of the re-render, but instead breaks the re-render chain, which can lead to unexpected behavior and make the code very hard to refactor.
-
-### Limit `useCallback` or `useMemo` usage
-
-They are often not necessary and will make the code harder to read and maintain for a gain of performance that is unnoticeable.
-
-## Console.logs
-
-`console.log` statements are invaluable during development, offering real-time insights into variable values and code flow. But, leaving them in production code can lead to several issues:
-
-1. **Performance**: Excessive logging can affect the runtime performance, specially on client-side applications.
-
-2. **Security**: Logging sensitive data can expose critical information to anyone who inspects the browser's console.
-
-3. **Cleanliness**: Filling up the console with logs can obscure important warnings or errors that developers or tools need to see.
-
-4. **Professionalism**: End users or clients checking the console and seeing a myriad of log statements might question the code's quality and polish.
-
-Make sure you remove all `console.logs` before pushing the code to production.
-
-## Naming
-
-### Variable Naming
-
-Variable names ought to precisely depict the purpose or function of the variable.
-
-#### The issue with generic names
-Generic names in programming are not ideal because they lack specificity, leading to ambiguity and reduced code readability. Such names fail to convey the variable or function's purpose, making it challenging for developers to understand the code's intent without deeper investigation. This can result in increased debugging time, higher susceptibility to errors, and difficulties in maintenance and collaboration. Meanwhile, descriptive naming makes the code self-explanatory and easier to navigate, enhancing code quality and developer productivity.
-
-```tsx
-// ❌ Bad, uses a generic name that doesn't communicate its
-// purpose or content clearly
-const [value, setValue] = useState('');
-```
-
-```tsx
-// ✅ Good, uses a descriptive name
-const [email, setEmail] = useState('');
-```
-
-#### Some words to avoid in variable names
-
- - dummy
-
-### Event handlers
-
-Event handler names should start with `handle`, while `on` is a prefix used to name events in components props.
-
-```tsx
-// ❌ Bad
-const onEmailChange = (val: string) => {
- // ...
-};
-```
-
-```tsx
-// ✅ Good
-const handleEmailChange = (val: string) => {
- // ...
-};
-```
-
-## Optional Props
-
-Avoid passing the default value for an optional prop.
-
-**EXAMPLE**
-
-Take the`EmailField` component defined below:
-
-```tsx
-type EmailFieldProps = {
- value: string;
- disabled?: boolean;
-};
-
-const EmailField = ({ value, disabled = false }: EmailFieldProps) => (
-
-);
-```
-
-**Usage**
-
-```tsx
-// ❌ Bad, passing in the same value as the default value adds no value
-const Form = () => ;
-```
-
-```tsx
-// ✅ Good, assumes the default value
-const Form = () => ;
-```
-
-## Component as props
-
-Try as much as possible to pass uninstantiated components as props, so children can decide on their own of what props they need to pass.
-
-The most common example for that is icon components:
-
-```tsx
-const SomeParentComponent = () => ;
-
-// In MyComponent
-const MyComponent = ({ MyIcon }: { MyIcon: IconComponent }) => {
- const theme = useTheme();
-
- return (
-
-
-
- )
-};
-```
-
-For React to understand that the component is a component, you need to use PascalCase, to later instantiate it with ``
-
-## Prop Drilling: Keep It Minimal
-
-Prop drilling, in the React context, refers to the practice of passing state variables and their setters through many component layers, even if intermediary components don't use them. While sometimes necessary, excessive prop drilling can lead to:
-
-1. **Decreased Readability**: Tracing where a prop originates or where it's utilized can become convoluted in a deeply nested component structure.
-
-2. **Maintenance Challenges**: Changes in one component's prop structure might require adjustments in several components, even if they don't directly use the prop.
-
-3. **Reduced Component Reusability**: A component receiving a lot of props solely for passing them down becomes less general-purpose and harder to reuse in different contexts.
-
-If you feel that you are using excessive prop drilling, see [state management best practices](#state-management).
-
-## Imports
-
-When importing, opt for the designated aliases rather than specifying complete or relative paths.
-
-**The Aliases**
-
-```js
-{
- alias: {
- "~": path.resolve(__dirname, "src"),
- "@": path.resolve(__dirname, "src/modules"),
- "@testing": path.resolve(__dirname, "src/testing"),
- },
-}
-```
-
-**Usage**
-```tsx
-// ❌ Bad, specifies the entire relative path
-import {
- CatalogDecorator
-} from '../../../../../testing/decorators/CatalogDecorator';
-import {
- ComponentDecorator
-} from '../../../../../testing/decorators/ComponentDecorator';
-```
-
-```tsx
-// ✅ Good, utilises the designated aliases
-import { CatalogDecorator } from '~/testing/decorators/CatalogDecorator';
-import { ComponentDecorator } from 'twenty-ui';=
-```
-
-## Schema Validation
-
-[Zod](https://github.com/colinhacks/zod) is the schema validator for untyped objects:
-
-```js
-const validationSchema = z
- .object({
- exist: z.boolean(),
- email: z
- .string()
- .email('Email must be a valid email'),
- password: z
- .string()
- .regex(PASSWORD_REGEX, 'Password must contain at least 8 characters'),
- })
- .required();
-
-type Form = z.infer;
-```
-
-
-## Breaking Changes
-
-Always perform thorough manual testing before proceeding to guarantee that modifications haven’t caused disruptions elsewhere, given that tests have not yet been extensively integrated.
-
diff --git a/packages/twenty-docs/docs/contributor/frontend/folder-architecture.mdx b/packages/twenty-docs/docs/contributor/frontend/folder-architecture.mdx
deleted file mode 100644
index cdeab4bc7..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/folder-architecture.mdx
+++ /dev/null
@@ -1,113 +0,0 @@
----
-title: Folder Architecture
-sidebar_position: 5
-description: A detailed look into our folder architecture
-sidebar_custom_props:
- icon: TbFolder
----
-
-In this guide, you will explore the details of the project directory structure and how it contributes to the organization and maintainability of Twenty.
-
-By following this folder architecture convention, it's easier to find the files related to specific features and ensure that the application is scalable and maintainable.
-
-```
-front
-└───modules
-│ └───module1
-│ │ └───submodule1
-│ └───module2
-│ └───ui
-│ │ └───display
-│ │ └───inputs
-│ │ │ └───buttons
-│ │ └───...
-└───pages
-└───...
-```
-
-## Pages
-
-Includes the top-level components defined by the application routes. They import more low-level components from the modules folder (more details below).
-
-## Modules
-
-Each module represents a feature or a group of feature, comprising its specific components, states, and operational logic.
-They should all follow the structure below. You can nest modules within modules (referred to as submodules) and the same rules will apply.
-
-```
-module1
- └───components
- │ └───component1
- │ └───component2
- └───constants
- └───contexts
- └───graphql
- │ └───fragments
- │ └───queries
- │ └───mutations
- └───hooks
- │ └───internal
- └───states
- │ └───selectors
- └───types
- └───utils
-```
-
-### Contexts
-
-A context is a way to pass data through the component tree without having to pass props down manually at every level.
-
-See [React Context](https://react.dev/reference/react#context-hooks) for more details.
-
-### GraphQL
-
-Includes fragments, queries, and mutations.
-
-See [GraphQL](https://graphql.org/learn/) for more details.
-
-- Fragments
-
-A fragment is a reusable piece of a query, which you can use in different places. By using fragments, it's easier to avoid duplicating code.
-
-See [GraphQL Fragments](https://graphql.org/learn/queries/#fragments) for more details.
-
-- Queries
-
-See [GraphQL Queries](https://graphql.org/learn/queries/) for more details.
-
-- Mutations
-
-See [GraphQL Mutations](https://graphql.org/learn/queries/#mutations) for more details.
-
-### Hooks
-
-See [Hooks](https://react.dev/learn/reusing-logic-with-custom-hooks) for more details.
-
-### States
-
-Contains the state management logic. [RecoilJS](https://recoiljs.org) handles this.
-
-- Selectors: See [RecoilJS Selectors](https://recoiljs.org/docs/basic-tutorial/selectors) for more details.
-
-React's built-in state management still handles state within a component.
-
-### Utils
-
-Should just contain reusable pure functions. Otherwise, create custom hooks in the `hooks` folder.
-
-
-## UI
-
-Contains all the reusable UI components used in the application.
-
-This folder can contain sub-folders, like `data`, `display`, `feedback`, and `input` for specific types of components. Each component should be self-contained and reusable, so that you can use it in different parts of the application.
-
-By separating the UI components from the other components in the `modules` folder, it's easier to maintain a consistent design and to make changes to the UI without affecting other parts (business logic) of the codebase.
-
-## Interface and dependencies
-
-You can import other module code from any module except for the `ui` folder. This will keep its code easy to test.
-
-### Internal
-
-Each part (hooks, states, ...) of a module can have an `internal` folder, which contains parts that are just used within the module.
diff --git a/packages/twenty-docs/docs/contributor/frontend/frontend.mdx b/packages/twenty-docs/docs/contributor/frontend/frontend.mdx
deleted file mode 100644
index 434bac164..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/frontend.mdx
+++ /dev/null
@@ -1,86 +0,0 @@
----
-id: frontend
-title: Frontend Development
-sidebar_position: 0
-sidebar_custom_props:
- icon: TbTerminal2
----
-
-import DocCardList from '@theme/DocCardList';
-
-
-
-
-## Useful commands
-
-### Starting the app
-
-```bash
- nx start twenty-front
- ```
-
-### Regenerate graphql schema based on API graphql schema
-
-```bash
-nx graphql:generate twenty-front
-```
-
-### Lint
-
-```bash
-nx lint twenty-front
-```
-
-### Test
-
-```bash
-nx test twenty-front# run jest tests
-nx storybook:dev twenty-front# run storybook
-nx storybook:test twenty-front# run tests # (needs yarn storybook:dev to be running)
-nx storybook:coverage twenty-front # (needs yarn storybook:dev to be running)
-```
-
-## Tech Stack
-
-The project has a clean and simple stack, with minimal boilerplate code.
-
-**App**
-
-- [React](https://react.dev/)
-- [Apollo](https://www.apollographql.com/docs/)
-- [GraphQL Codegen](https://the-guild.dev/graphql/codegen)
-- [Recoil](https://recoiljs.org/docs/introduction/core-concepts)
-- [TypeScript](https://www.typescriptlang.org/)
-
-**Testing**
-
-- [Jest](https://jestjs.io/)
-- [Storybook](https://storybook.js.org/)
-
-**Tooling**
-
-- [Yarn](https://yarnpkg.com/)
-- [Craco](https://craco.js.org/docs/)
-- [ESLint](https://eslint.org/)
-
-## Architecture
-
-### Routing
-
-[React Router](https://reactrouter.com/) handles the routing.
-
-To avoid unnecessary [re-renders](/contributor/frontend/best-practices#managing-re-renders) all the routing logic is in a `useEffect` in `PageChangeEffect`.
-
-### State Management
-
-[Recoil](https://recoiljs.org/docs/introduction/core-concepts) handles state management.
-
-See [best practices](/contributor/frontend/best-practices#state-management) for more information on state management.
-
-## Testing
-
-[Jest](https://jestjs.io/) serves as the tool for unit testing while [Storybook](https://storybook.js.org/) is for component testing.
-
-Jest is mainly for testing utility functions, and not components themselves.
-
-Storybook is for testing the behavior of isolated components, as well as displaying the design system.
diff --git a/packages/twenty-docs/docs/contributor/frontend/hotkeys.mdx b/packages/twenty-docs/docs/contributor/frontend/hotkeys.mdx
deleted file mode 100644
index 15884bebf..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/hotkeys.mdx
+++ /dev/null
@@ -1,179 +0,0 @@
----
-title: Hotkeys
-sidebar_position: 11
-sidebar_custom_props:
- icon: TbKeyboard
----
-
-## Introduction
-
-When you need to listen to a hotkey, you would normally use the `onKeyDown` event listener.
-
-In `twenty-front` however, you might have conflicts between same hotkeys that are used in different components, mounted at the same time.
-
-For example, if you have a page that listens for the Enter key, and a modal that listens for the Enter key, with a Select component inside that modal that listens for the Enter key, you might have a conflict when all are mounted at the same time.
-
-## The `useScopedHotkeys` hook
-
-To handle this problem, we have a custom hook that makes it possible to listen to hotkeys without any conflict.
-
-You place it in a component and it will listen to the hotkeys only when the component is mounted AND when the specified **hotkey scope** is active.
-
-## How to listen for hotkeys in practice ?
-
-There are two steps involved in setting up hotkey listening :
-1. Set the [hotkey scope](#what-is-a-hotkey-scope-) that will listen to hotkeys
-2. Use the `useScopedHotkeys` hook to listen to hotkeys
-
-Setting up hotkey scopes is required even in simple pages, because other UI elements like left menu or command menu might also listen to hotkeys.
-
-## Use cases for hotkeys
-
-In general, you'll have two use cases that require hotkeys :
-1. In a page or a component mounted in a page
-2. In a modal-type component that takes the focus due to a user action
-
-The second use case can happen recursively : a dropdown in a modal for example.
-
-### Listening to hotkeys in a page
-
-Example :
-
-```tsx
-const PageListeningEnter = () => {
- const {
- setHotkeyScopeAndMemorizePreviousScope,
- goBackToPreviousHotkeyScope,
- } = usePreviousHotkeyScope();
-
- // 1. Set the hotkey scope in a useEffect
- useEffect(() => {
- setHotkeyScopeAndMemorizePreviousScope(
- ExampleHotkeyScopes.ExampleEnterPage,
- );
-
- // Revert to the previous hotkey scope when the component is unmounted
- return () => {
- goBackToPreviousHotkeyScope();
- };
- }, [goBackToPreviousHotkeyScope, setHotkeyScopeAndMemorizePreviousScope]);
-
- // 2. Use the useScopedHotkeys hook
- useScopedHotkeys(
- Key.Enter,
- () => {
- // Some logic executed on this page when the user presses Enter
- // ...
- },
- ExampleHotkeyScopes.ExampleEnterPage,
- );
-
- return
My page that listens for Enter
;
-};
-```
-
-### Listening to hotkeys in a modal-type component
-
-For this example we'll use a modal component that listens for the Escape key to tell it's parent to close it.
-
-Here the user interaction is changing the scope.
-
-```tsx
-const ExamplePageWithModal = () => {
- const [showModal, setShowModal] = useState(false);
-
- const {
- setHotkeyScopeAndMemorizePreviousScope,
- goBackToPreviousHotkeyScope,
- } = usePreviousHotkeyScope();
-
- const handleOpenModalClick = () => {
- // 1. Set the hotkey scope when user opens the modal
- setShowModal(true);
- setHotkeyScopeAndMemorizePreviousScope(
- ExampleHotkeyScopes.ExampleModal,
- );
- };
-
- const handleModalClose = () => {
- // 1. Revert to the previous hotkey scope when the modal is closed
- setShowModal(false);
- goBackToPreviousHotkeyScope();
- };
-
- return
-
My page with a modal
-
- {showModal && }
-
;
-};
-```
-
-Then in the modal component :
-
-```tsx
-const MyDropdownComponent = ({ onClose }: { onClose: () => void }) => {
- // 2. Use the useScopedHotkeys hook to listen for Escape.
- // Note that escape is a common hotkey that could be used by many other components
- // So it's important to use a hotkey scope to avoid conflicts
- useScopedHotkeys(
- Key.Escape,
- () => {
- onClose()
- },
- ExampleHotkeyScopes.ExampleModal,
- );
-
- return
My modal component
;
-};
-```
-
-It's important to use this pattern when you're not sure that just using a useEffect with mount/unmount will be enough to avoid conflicts.
-
-Those conflicts can be hard to debug, and it might happen more often than not with useEffects.
-
-## What is a hotkey scope ?
-
-A hotkey scope is a string that represents a context in which the hotkeys are active. It is generally encoded as an enum.
-
-When you change the hotkey scope, the hotkeys that are listening to this scope will be enabled and the hotkeys that are listening to other scopes will be disabled.
-
-You can set only one scope at a time.
-
-As an example, the hotkey scopes for each page are defined in the `PageHotkeyScope` enum:
-
-```tsx
-export enum PageHotkeyScope {
- Settings = 'settings',
- CreateWokspace = 'create-workspace',
- SignInUp = 'sign-in-up',
- CreateProfile = 'create-profile',
- PlanRequired = 'plan-required',
- ShowPage = 'show-page',
- PersonShowPage = 'person-show-page',
- CompanyShowPage = 'company-show-page',
- CompaniesPage = 'companies-page',
- PeoplePage = 'people-page',
- OpportunitiesPage = 'opportunities-page',
- ProfilePage = 'profile-page',
- WorkspaceMemberPage = 'workspace-member-page',
- TaskPage = 'task-page',
-}
-```
-
-Internally, the currently selected scope is stored in a Recoil state that is shared across the application :
-
-```tsx
-export const currentHotkeyScopeState = createState({
- key: 'currentHotkeyScopeState',
- defaultValue: INITIAL_HOTKEYS_SCOPE,
-});
-```
-
-But this Recoil state should never be handled manually ! We'll see how to use it in the next section.
-
-## How is it working internally ?
-
-We made a thin wrapper on top of [react-hotkeys-hook](https://react-hotkeys-hook.vercel.app/docs/intro) that makes it more performant and avoids unnecessary re-renders.
-
-We also create a Recoil state to handle the hotkey scope state and make it available everywhere in the application.
diff --git a/packages/twenty-docs/docs/contributor/frontend/style-guide.mdx b/packages/twenty-docs/docs/contributor/frontend/style-guide.mdx
deleted file mode 100644
index b53dab55f..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/style-guide.mdx
+++ /dev/null
@@ -1,291 +0,0 @@
----
-title: Style Guide
-sidebar_position: 4
-sidebar_custom_props:
- icon: TbPencil
----
-
-This document includes the rules to follow when writing code.
-
-The goal here is to have a consistent codebase, which is easy to read and easy to maintain.
-
-For this, it's better to be a bit more verbose than to be too concise.
-
-Always keep in mind that people read code more often than they write it, specially on an open source project, where anyone can contribute.
-
-There are a lot of rules that are not defined here, but that are automatically checked by linters.
-
-## React
-
-### Use functional components
-
-Always use TSX functional components.
-
-Do not use default `import` with `const`, because it's harder to read and harder to import with code completion.
-
-```tsx
-// ❌ Bad, harder to read, harder to import with code completion
-const MyComponent = () => {
- return
Hello World
;
-};
-
-export default MyComponent;
-
-// ✅ Good, easy to read, easy to import with code completion
-export function MyComponent() {
- return
Hello World
;
-};
-```
-
-### Props
-
-Create the type of the props and call it `(ComponentName)Props` if there's no need to export it.
-
-Use props destructuring.
-
-```tsx
-// ❌ Bad, no type
-export const MyComponent = (props) =>
;
-```
-
-#### Refrain from using `React.FC` or `React.FunctionComponent` to define prop types
-
-```tsx
-/* ❌ - Bad, defines the component type annotations with `FC`
- * - With `React.FC`, the component implicitly accepts a `children` prop
- * even if it's not defined in the prop type. This might not always be
- * desirable, especially if the component doesn't intend to render
- * children.
- */
-const EmailField: React.FC<{
- value: string;
-}> = ({ value }) => ;
-```
-
-```tsx
-/* ✅ - Good, a separate type (OwnProps) is explicitly defined for the
- * component's props
- * - This method doesn't automatically include the children prop. If
- * you want to include it, you have to specify it in OwnProps.
- */
-type EmailFieldProps = {
- value: string;
-};
-
-const EmailField = ({ value }: EmailFieldProps) => (
-
-);
-```
-
-#### No Single Variable Prop Spreading in JSX Elements
-
-Avoid using single variable prop spreading in JSX elements, like `{...props}`. This practice often results in code that is less readable and harder to maintain because it's unclear which props the component is receiving.
-
-```tsx
-/* ❌ - Bad, spreads a single variable prop into the underlying component
- */
-const MyComponent = (props: OwnProps) => {
- return ;
-}
-```
-
-```tsx
-/* ✅ - Good, Explicitly lists all props
- * - Enhances readability and maintainability
- */
-const MyComponent = ({ prop1, prop2, prop3 }: MyComponentProps) => {
- return ;
-};
-```
-
-Rationale:
-- At a glance, it's clearer which props the code passes down, making it easier to understand and maintain.
-- It helps to prevent tight coupling between components via their props.
-- Linting tools make it easier to identify misspelled or unused props when you list props explicitly.
-
-## JavaScript
-
-### Use nullish-coalescing operator `??`
-
-```tsx
-// ❌ Bad, can return 'default' even if value is 0 or ''
-const value = process.env.MY_VALUE || 'default';
-
-// ✅ Good, will return 'default' only if value is null or undefined
-const value = process.env.MY_VALUE ?? 'default';
-```
-
-### Use optional chaining `?.`
-
-```tsx
-// ❌ Bad
-onClick && onClick();
-
-// ✅ Good
-onClick?.();
-```
-
-## TypeScript
-
-### Use `type` instead of `interface`
-
-Always use `type` instead of `interface`, because they almost always overlap, and `type` is more flexible.
-
-```tsx
-// ❌ Bad
-interface MyInterface {
- name: string;
-}
-
-// ✅ Good
-type MyType = {
- name: string;
-};
-```
-
-### Use string literals instead of enums
-
-[String literals](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#literal-types) are the go-to way to handle enum-like values in TypeScript. They are easier to extend with Pick and Omit, and offer a better developer experience, specially with code completion.
-
-You can see why TypeScript recommends avoiding enums [here](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#enums).
-
-```tsx
-// ❌ Bad, utilizes an enum
-enum Color {
- Red = "red",
- Green = "green",
- Blue = "blue",
-}
-
-let color = Color.Red;
-```
-
-```tsx
-// ✅ Good, utilizes a string literal
-let color: "red" | "green" | "blue" = "red";
-```
-
-#### GraphQL and internal libraries
-
-You should use enums that GraphQL codegen generates.
-
-It's also better to use an enum when using an internal library, so the internal library doesn't have to expose a string literal type that is not related to the internal API.
-
-Example:
-
-```TSX
-const {
- setHotkeyScopeAndMemorizePreviousScope,
- goBackToPreviousHotkeyScope,
-} = usePreviousHotkeyScope();
-
-setHotkeyScopeAndMemorizePreviousScope(
- RelationPickerHotkeyScope.RelationPicker,
-);
-```
-
-## Styling
-
-### Use StyledComponents
-
-Style the components with [styled-components](https://emotion.sh/docs/styled).
-
-```tsx
-// ❌ Bad
-
Hello World
-```
-
-```tsx
-// ✅ Good
-const StyledTitle = styled.div`
- color: red;
-`;
-```
-
-Prefix styled components with "Styled" to differentiate them from "real" components.
-
-```tsx
-// ❌ Bad
-const Title = styled.div`
- color: red;
-`;
-```
-
-```tsx
-// ✅ Good
-const StyledTitle = styled.div`
- color: red;
-`;
-```
-
-### Theming
-
-Utilizing the theme for the majority of component styling is the preferred approach.
-
-#### Units of measurement
-
-Avoid using `px` or `rem` values directly within the styled components. The necessary values are generally already defined in the theme, so it’s recommended to make use of the theme for these purposes.
-
-#### Colors
-
-Refrain from introducing new colors; instead, use the existing palette from the theme. Should there be a situation where the palette does not align, please leave a comment so that the team can rectify it.
-
-
-```tsx
-// ❌ Bad, directly specifies style values without utilizing the theme
-const StyledButton = styled.button`
- color: #333333;
- font-size: 1rem;
- font-weight: 400;
- margin-left: 4px;
- border-radius: 50px;
-`;
-```
-
-```tsx
-// ✅ Good, utilizes the theme
-const StyledButton = styled.button`
- color: ${({ theme }) => theme.font.color.primary};
- font-size: ${({ theme }) => theme.font.size.md};
- font-weight: ${({ theme }) => theme.font.weight.regular};
- margin-left: ${({ theme }) => theme.spacing(1)};
- border-radius: ${({ theme }) => theme.border.rounded};
-`;
-```
-## Enforcing No-Type Imports
-
-Avoid type imports. To enforce this standard, an ESLint rule checks for and reports any type imports. This helps maintain consistency and readability in the TypeScript code.
-
-```tsx
-// ❌ Bad
-import { type Meta, type StoryObj } from '@storybook/react';
-
-// ❌ Bad
-import type { Meta, StoryObj } from '@storybook/react';
-
-// ✅ Good
-import { Meta, StoryObj } from '@storybook/react';
-```
-
-### Why No-Type Imports
-
-- **Consistency**: By avoiding type imports and using a single approach for both type and value imports, the codebase remains consistent in its module import style.
-
-- **Readability**: No-type imports improve code readability by making it clear when you're importing values or types. This reduces ambiguity and makes it easier to understand the purpose of imported symbols.
-
-- **Maintainability**: It enhances codebase maintainability because developers can identify and locate type-only imports when reviewing or modifying code.
-
-### ESLint Rule
-
-An ESLint rule, `@typescript-eslint/consistent-type-imports`, enforces the no-type import standard. This rule will generate errors or warnings for any type import violations.
-
-Please note that this rule specifically addresses rare edge cases where unintentional type imports occur. TypeScript itself discourages this practice, as mentioned in the [TypeScript 3.8 release notes](https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-8.html). In most situations, you should not need to use type-only imports.
-
-To ensure your code complies with this rule, make sure to run ESLint as part of your development workflow.
diff --git a/packages/twenty-docs/docs/contributor/frontend/work-with-figma.mdx b/packages/twenty-docs/docs/contributor/frontend/work-with-figma.mdx
deleted file mode 100644
index e1cda50d3..000000000
--- a/packages/twenty-docs/docs/contributor/frontend/work-with-figma.mdx
+++ /dev/null
@@ -1,65 +0,0 @@
----
-title: Work with Figma
-description: Learn how you can collaborate with Twenty's Figma
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbBrandFigma
----
-
-Figma is a collaborative interface design tool that aids in bridging the communication barrier between designers and developers.
-This guide explains how you can collaborate with Figma.
-
-## Access
-
-1. **Access the shared link:** You can access the project's Figma file [here](https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty).
-2. **Sign in:** If you're not already signed in, Figma will prompt you to do so.
-Key features are only available to logged-in users, such as the developer mode and the ability to select a dedicated frame.
-
-:::caution Note
-
-You will not be able to collaborate effectively without an account.
-
-:::
-
-
-## Figma structure
-
-On the left sidebar, you can access the different pages of Twenty's Figma. This is how they're organized:
-
-- **Components page:** This is the first page. The designer uses it to create and organize the reusable design elements used throughout the design file. For example, buttons, icons, symbols, or any other reusable components. It serves to maintain consistency across the design.
-- **Main page:** The second page is the main page, which shows the complete user interface of the project. You can press ***Play*** to use the full app prototype.
-- **Features pages:** The other pages are typically dedicated to features in progress. They contain the design of specific features or modules of the application or website. They are typically still in progress.
-
-## Useful Tips
-
-With read-only access, you can't edit the design but you can access all features that will be useful to convert the designs into code.
-
-### Use the Dev mode
-
-Figma's Dev Mode enhances developers' productivity by providing easy design navigation, effective asset management, efficient communication tools, toolbox integrations, quick code snippets, and key layer information, bridging the gap between design and development. You can learn more about Dev Mode [here](https://www.figma.com/dev-mode/).
-
-Switch to the "Developer" mode in the right part of the toolbar to see design specs, copy CSS, and access assets.
-
-### Use the Prototype
-
-Click on any element on the canvas and press the “Play” button at the top right edge of the interface to access the prototype view. Prototype mode allows you to interact with the design as if it were the final product. It demonstrates the flow between screens and how interface elements like buttons, links, or menus behave when interacted with.
-
-1. **Understanding transitions and animations:** In the Prototype mode, you can view any transitions or animations added by a designer between screens or UI elements, providing clear visual instructions to developers on the intended behavior and style.
-2. **Implementation clarification:** A prototype can also help reduce ambiguities. Developers can interact with it to gain a better understanding of the functionality or appearance of particular elements.
-
-For more comprehensive details and guidance on learning the Figma platform, you can visit the official [Figma Documentation](https://help.figma.com/hc/en-us).
-
-### Measure distances
-
-Select an element, hold `Option` key (Mac) or `Alt` key (Windows), then hover over another element to see the distance between them.
-
-### Figma extension for VSCode (Recommended)
-
-[Figma for VS Code](https://marketplace.visualstudio.com/items?itemName=figma.figma-vscode-extension)
-lets you navigate and inspect design files, collaborate with designers, track changes, and speed up implementation - all without leaving your text editor.
-It's part of our recommended extensions.
-
-## Collaboration
-
-1. **Using Comments:** You are welcome to use the comment feature by clicking on the bubble icon in the left part of the toolbar.
-2. **Cursor chat:** A nice feature of Figma is the Cursor chat. Just press `;` on Mac and `/` on Windows to send a message if you see someone else using Figma as the same time as you.
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/contributor/server/_category_.json b/packages/twenty-docs/docs/contributor/server/_category_.json
deleted file mode 100644
index cf5d22abc..000000000
--- a/packages/twenty-docs/docs/contributor/server/_category_.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "position": 4,
- "collapsible": true,
- "collapsed": true
-}
diff --git a/packages/twenty-docs/docs/contributor/server/best-practices.mdx b/packages/twenty-docs/docs/contributor/server/best-practices.mdx
deleted file mode 100644
index b84a3ed19..000000000
--- a/packages/twenty-docs/docs/contributor/server/best-practices.mdx
+++ /dev/null
@@ -1,25 +0,0 @@
----
-title: Best Practices
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbChecklist
----
-
-This document outlines the best practices you should follow when working on the backend.
-
-## Follow a modular approach
-
-The backend follows a modular approach, which is a fundamental principle when working with NestJS. Make sure you break down your code into reusable modules to maintain a clean and organized codebase.
-Each module should encapsulate a particular feature or functionality and have a well-defined scope. This modular approach enables clear separation of concerns and removes unnecessary complexities.
-
-## Expose services to use in modules
-
-Always create services that have a clear and single responsibility, which enhances code readability and maintainability. Name the services descriptively and consistently.
-
-You should also expose services that you want to use in other modules. Exposing services to other modules is possible through NestJS's powerful dependency injection system, and promotes loose coupling between components.
-
-## Avoid using `any` type
-
-When you declare a variable as `any`, TypeScript's type checker doesn't perform any type checking, making it possible to assign any type of values to the variable. TypeScript uses type inference to determine the type of variable based on the value. By declaring it as `any`, TypeScript can no longer infer the type. This makes it hard to catch type-related errors during development, leading to runtime errors and makes the code less maintainable, less reliable, and harder to understand for others.
-
-This is why everything should have a type. So if you create a new object with a first name and last name, you should create an interface or type that contains a first name and last name that defines the shape of the object you are manipulating.
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/contributor/server/custom-objects.mdx b/packages/twenty-docs/docs/contributor/server/custom-objects.mdx
deleted file mode 100644
index a23732549..000000000
--- a/packages/twenty-docs/docs/contributor/server/custom-objects.mdx
+++ /dev/null
@@ -1,41 +0,0 @@
----
-title: Custom Objects
-sidebar_position: 4
-sidebar_custom_props:
- icon: TbAugmentedReality
----
-
-Objects are structures that allow you to store data (records, attributes, and values) specific to an organization. Twenty provides both standard and custom objects.
-
-Standard objects are in-built objects with a set of attributes available for all users. Examples of standard objects in Twenty include Company and Person. Standard objects have standard fields that are also available for all Twenty users, like Company.displayName.
-
-Custom objects are objects that you can create to store information that is unique to your organization. They are not built-in; members of your workspace can create and customize custom objects to hold information that standard objects aren't suitable for.
-
-
-## High-level schema
-
-
-
-
-
-
-
-## How it works
-
-Custom objects come from metadata tables that determine the shape, name, and type of the objects. All this information is present in the metadata schema database, consisting of tables:
-
-- **DataSource**: Details where the data is present.
-- **Object**: Describes the object and links to a DataSource.
-- **Field**: Outlines an Object's fields and connects to the Object.
-
-To add a custom object, the workspaceMember will query the /metadata API. This updates the metadata accordingly and computes a GraphQL schema based on the metadata, storing it in a GQL cache for later use.
-
-
-
-
-
-
-To fetch data, the process involves making queries through the /graphql endpoint and passing them through the Query Resolver.
-
-
-
diff --git a/packages/twenty-docs/docs/contributor/server/feature-flags.mdx b/packages/twenty-docs/docs/contributor/server/feature-flags.mdx
deleted file mode 100644
index 9ccbf049b..000000000
--- a/packages/twenty-docs/docs/contributor/server/feature-flags.mdx
+++ /dev/null
@@ -1,52 +0,0 @@
----
-title: Feature Flags
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbFlag
----
-
-Feature flags are used to hide experimental features. For twenty they are set on workspace level and not on a user level.
-
-## Adding a new feature flag
-
-In `FeatureFlagKey.ts` add the feature flag:
-
-```ts
-type FeatureFlagKey =
- | 'IS_FEATURENAME_ENABLED'
- | ...;
-```
-
-Also add it to the enum in `feature-flag.entity.ts`:
-
-```ts
-enum FeatureFlagKeys {
- IsFeatureNameEnabled = 'IS_FEATURENAME_ENABLED',
- ...
-}
-```
-
-
-
-To apply a feature flag on a **backend** feature use:
-
-```ts
-@Gate({
- featureFlag: 'IS_FEATURENAME_ENABLED',
-})
-```
-
-To apply a feature flag on a **frontend** feature use:
-
-```ts
-const isFeatureNameEnabled = useIsFeatureEnabled('IS_FEATURENAME_ENABLED');
-```
-
-
-## Configure feature flags for the deployment
-
-Change the corresponding record in the Table `core.featureFlag`:
-
-| id | key | workspaceId | value |
-|----------|--------------------------|---------------|--------|
-| Random | `IS_FEATURENAME_ENABLED` | WorkspaceID | `true` |
diff --git a/packages/twenty-docs/docs/contributor/server/folder-architecture.mdx b/packages/twenty-docs/docs/contributor/server/folder-architecture.mdx
deleted file mode 100644
index 4a59213bc..000000000
--- a/packages/twenty-docs/docs/contributor/server/folder-architecture.mdx
+++ /dev/null
@@ -1,132 +0,0 @@
----
-title: Folder Architecture
-sidebar_position: 2
-description: A detailed look into our server folder architecture
-sidebar_custom_props:
- icon: TbFolder
----
-
-
-The backend directory structure is as follows:
-
-```
-server
- └───ability
- └───constants
- └───core
- └───database
- └───decorators
- └───filters
- └───guards
- └───health
- └───integrations
- └───metadata
- └───workspace
- └───utils
-```
-
-## Ability
-
-Defines permissions and includes handlers for each entity.
-
-## Decorators
-
-Defines custom decorators in NestJS for added functionality.
-
-See [custom decorators](https://docs.nestjs.com/custom-decorators) for more details.
-
-## Filters
-
-Includes exception filters to handle exceptions that might occur in GraphQL endpoints.
-
-## Guards
-
-See [guards](https://docs.nestjs.com/guards) for more details.
-
-## Health
-
-Includes a publicly available REST API (healthz) that returns a JSON to confirm whether the database is working as expected.
-
-## Metadata
-
-Defines custom objects and makes available a GraphQL API (graphql/metadata).
-
-## Workspace
-
-Generates and serves custom GraphQL schema based on the metadata.
-
-### Workspace Directory Structure
-
-```
-workspace
- └───workspace-schema-builder
- └───factories
- └───graphql-types
- └───database
- └───interfaces
- └───object-definitions
- └───services
- └───storage
- └───utils
- └───workspace-resolver-builder
- └───factories
- └───interfaces
- └───workspace-query-builder
- └───factories
- └───interfaces
- └───workspace-query-runner
- └───interfaces
- └───utils
- └───workspace-datasource
- └───workspace-manager
- └───workspace-migration-runner
- └───utils
- └───workspace.module.ts
- └───workspace.factory.spec.ts
- └───workspace.factory.ts
-```
-
-
-The root of the workspace directory includes the `workspace.factory.ts`, a file containing the `createGraphQLSchema` function. This function generates workspace-specific schema by using the metadata to tailor a schema for individual workspaces. By separating the schema and resolver construction, we use the `makeExecutableSchema` function, which combines these discrete elements.
-
-This strategy is not just about organization, but also helps with optimization, such as caching generated type definitions to enhance performance and scalability.
-
-### Workspace Schema builder
-
-Generates the GraphQL schema, and includes:
-
-#### Factories:
-
-Specialised constructors to generate GraphQL-related constructs.
-- The type.factory translates field metadata into GraphQL types using `TypeMapperService`.
-- The type-definition.factory creates GraphQL input or output objects derived from `objectMetadata`.
-
-#### GraphQL Types
-
-Includes enumerations, inputs, objects, and scalars, and serves as the building blocks for the schema construction.
-
-#### Interfaces and Object Definitions
-
-Contains the blueprints for GraphQL entities, and includes both predefined and custom types like `MONEY` or `URL`.
-
-#### Services
-
-Contains the service responsible for associating FieldMetadataType with its appropriate GraphQL scalar or query modifiers.
-
-#### Storage
-
-Includes the `TypeDefinitionsStorage` class that contains reusable type definitions, preventing duplication of GraphQL types.
-
-### Workspace Resolver Builder
-
-Creates resolver functions for querying and mutatating the GraphQL schema.
-
-Each factory in this directory is responsible for producing a distinct resolver type, such as the `FindManyResolverFactory`, designed for adaptable application across various tables.
-
-### Workspace Query Builder
-
-Includes factories that generate `pg_graphql` queries.
-
-### Workspace Query Runner
-
-Runs the generated queries on the database and parses the result.
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/contributor/server/queue.mdx b/packages/twenty-docs/docs/contributor/server/queue.mdx
deleted file mode 100644
index 4425f9865..000000000
--- a/packages/twenty-docs/docs/contributor/server/queue.mdx
+++ /dev/null
@@ -1,47 +0,0 @@
----
-title: Message Queue
-sidebar_position: 5
-sidebar_custom_props:
- icon: TbSchema
----
-
-Queues facilitate async operations to be performed. They can be used for performing background tasks such as sending a welcome email on register.
-Each use case will have its own queue class extended from `MessageQueueServiceBase`.
-
-Currently, queue supports two drivers which can be configurred by env variable `MESSAGE_QUEUE_TYPE`.
-1. `pg-boss`: this is the default driver, which uses [pg-boss](https://github.com/timgit/pg-boss) under the hood.
-2. `bull-mq`: this uses [bull-mq](https://bullmq.io/) under the hood.
-
-## Steps to create and use a new queue
-
-1. Add a queue name for your new queue under enum `MESSAGE_QUEUES`.
-2. Provide the factory implementation of the queue with the queue name as the dependency token.
-3. Inject the queue that you created in the required module/service with the queue name as the dependency token.
-4. Add worker class with token based injection just like producer.
-
-### Example usage
-```ts
-class Resolver {
- constructor(@Inject(MESSAGE_QUEUES.custom) private queue: MessageQueueService) {}
-
- async onSomeAction() {
- //business logic
- await this.queue.add(someData);
- }
-}
-
-//async worker
-class CustomWorker {
- constructor(@Inject(MESSAGE_QUEUES.custom) private queue: MessageQueueService) {
- this.initWorker();
- }
-
- async initWorker() {
- await this.queue.work(async ({ id, data }) => {
- //worker logic
- });
- }
-}
-
-```
-
diff --git a/packages/twenty-docs/docs/contributor/server/server.mdx b/packages/twenty-docs/docs/contributor/server/server.mdx
deleted file mode 100644
index 4082d33ac..000000000
--- a/packages/twenty-docs/docs/contributor/server/server.mdx
+++ /dev/null
@@ -1,87 +0,0 @@
----
-title: Backend Development
-sidebar_position: 0
-sidebar_custom_props:
- icon: TbTerminal
----
-
-
-import DocCardList from '@theme/DocCardList';
-
-
-
-
-## Useful commands
-
-These commands should be exectued from packages/twenty-server folder.
-From any other folder you can run `npx nx ` twenty-server.
-
-### First time setup
-
-```
-npx nx database:reset # setup the database with dev seeds
-```
-
-### Starting the app
-
-```
-npx nx start
-```
-
-### Lint
-
-```
-npx nx lint
-```
-
-### Test
-
-```
-npx nx test:unit
-```
-
-### Resetting the database
-
-If you want to reset the database, you can run the following command:
-
-```bash
-npx nx database:reset
-```
-
-:::warning
-
-This will drop the database and re-run the migrations and seed.
-
-Make sure to back up any data you want to keep before running this command.
-
-:::
-
-## Tech Stack
-
-Twenty primarily uses NestJS for the backend.
-
-Prisma was the first ORM we used. But in order to allow users to create custom fields and custom objects, a lower-level made more sense as we need to have fine-grained control. The project now uses TypeORM.
-
-Here's what the tech stack now looks like.
-
-
-**Core**
-- [NestJS](https://nestjs.com/)
-- [TypeORM](https://typeorm.io/)
-- [GraphQL Yoga](https://the-guild.dev/graphql/yoga-server)
-
-**Database**
-- [Postgres](https://www.postgresql.org/)
-
-**Third-party integrations**
-- [Sentry](https://sentry.io/welcome/) for tracking bugs
-
-**Testing**
-- [Jest](https://jestjs.io/)
-
-**Tooling**
-- [Yarn](https://yarnpkg.com/)
-- [ESLint](https://eslint.org/)
-
-**Development**
-- [AWS EKS](https://aws.amazon.com/eks/)
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/contributor/server/zapier.mdx b/packages/twenty-docs/docs/contributor/server/zapier.mdx
deleted file mode 100644
index 4407474ce..000000000
--- a/packages/twenty-docs/docs/contributor/server/zapier.mdx
+++ /dev/null
@@ -1,75 +0,0 @@
----
-title: Zapier App
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbBrandZapier
----
-
-Effortlessly sync Twenty with 3000+ apps using [Zapier](https://zapier.com/). Automate tasks, boost productivity, and supercharge your customer relationships!
-
-## About Zapier
-
-Zapier is a tool that allows you automate workflows by connecting the apps that your team uses everyday. The fundamental concept of Zapier is automation workflows, called Zaps, and include triggers and actions.
-
-You can learn more about how Zapier works [here](https://zapier.com/how-it-works).
-
-## Setup
-
-### Step 1: Install Zapier packages
-
-```bash
-cd packages/twenty-zapier
-yarn
-```
-
-### Step 2: Login with the CLI
-
-Use your Zapier credentials to log in using the CLI:
-
-```bash
-zapier login
-```
-
-### Step 3: Set environment variables
-
-From the `packages/twenty-zapier` folder, run:
-
-```bash
-cp .env.example .env
-```
-Run the application locally, go to [http://localhost:3000/settings/developers](http://localhost:3000/settings/developers/api-keys), and generate an API key.
-
-Replace the **YOUR_API_KEY** value in the `.env` file with the API key you just generated.
-
-## Development
-
-:::caution Note
-
-Make sure to run `yarn build` before any `zapier` command.
-
-:::
-
-### Test
-```bash
-yarn test
-```
-### Lint
-```bash
-yarn format
-```
-### Watch and compile as you edit code
-```bash
-yarn watch
-```
-### Validate your Zapier app
-```bash
-yarn validate
-```
-### Deploy your Zapier app
-```bash
-yarn deploy
-```
-### List all Zapier CLI commands
-```bash
-zapier
-```
diff --git a/packages/twenty-docs/docs/index.mdx b/packages/twenty-docs/docs/index.mdx
deleted file mode 100644
index 160b8bbe1..000000000
--- a/packages/twenty-docs/docs/index.mdx
+++ /dev/null
@@ -1,26 +0,0 @@
----
-id: homepage
-sidebar_position: 0
-sidebar_class_name: display-none
-title: Welcome
-hide_title: true
-hide_table_of_contents: true
-custom_edit_url: null
-pagination_next: null
----
-import ThemedImage from '@theme/ThemedImage';
-
-
-Twenty is a CRM designed to fit your unique business needs.
-It is maintained by a community of 200+ developers that care about building high-quality software.
-
-There are three different ways to get started:
-- **Managed Cloud:** The fastest and easiest way to try the app
-- **Local Setup:** If you're a developer and would like to contribute to the app
-- **Self-Hosting:** If you know how to run a server and want to host the app yourself
-
-
-Once you're setup, you can check the "Extending" or "Contributing" section to start building.
-
-
-
diff --git a/packages/twenty-docs/docs/start/_category_.json b/packages/twenty-docs/docs/start/_category_.json
deleted file mode 100644
index 3562d433d..000000000
--- a/packages/twenty-docs/docs/start/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "Getting Started",
- "position": 1
-}
diff --git a/packages/twenty-docs/docs/start/cloud.mdx b/packages/twenty-docs/docs/start/cloud.mdx
deleted file mode 100644
index 84538217b..000000000
--- a/packages/twenty-docs/docs/start/cloud.mdx
+++ /dev/null
@@ -1,23 +0,0 @@
----
-title: Managed Cloud
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbRocket
----
-import ThemedImage from '@theme/ThemedImage';
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-
-The easiest way to try the app is to sign up on [app.twenty.com](https://app.twenty.com).
-
-We offer a free trial but require a credit-card to signup.
-
-If you just want to play around with a test instance you can use these credentials on [demo.twenty.com](https://demo.twenty.com):
-
-```
-email: noah@demo.dev
-password: Applecar2025
-```
-
-Expect the demo to occasionnaly have bugs; it's used for testing purposes and therefore is running a version of the software that's newer than the production environment.
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/start/local-setup.mdx b/packages/twenty-docs/docs/start/local-setup.mdx
deleted file mode 100644
index b73eda911..000000000
--- a/packages/twenty-docs/docs/start/local-setup.mdx
+++ /dev/null
@@ -1,226 +0,0 @@
----
-title: Local Setup
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbDeviceDesktop
----
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-
-Follow this guide if you would like to setup the project locally to contribute.
-
-## Prerequisites
-
-
-
-
-Before you can install and use Twenty, make sure you install the following on your computer:
-- [Git](https://git-scm.com/book/en/v2/Getting-Started-Installing-Git)
-- [Node v18](https://nodejs.org/en/download)
-- [yarn v4](https://yarnpkg.com/getting-started/install)
-- [nvm](https://github.com/nvm-sh/nvm/blob/master/README.md)
-
-:::info Note
-`npm` won't work, you should use `yarn` instead. Yarn is now shipped with Node.js, so you don't need to install it separately.
-You only have to run `corepack enable` to enable Yarn if you haven't done it yet.
-:::
-
-
-
-
-
-1. Install WSL
-Open PowerShell as Administrator and run:
-
-```powershell
-wsl --install
-```
-You should now see a prompt to restart your computer. If not, restart it manually.
-
-Upon restart, a powershell window will open and install Ubuntu. This may take up some time.
-You'll see a prompt to create a username and password for your Ubuntu installation.
-
-2. Install and configure git
-
-```bash
-sudo apt-get install git
-git config --global user.name "Your Name"
-git config --global user.email "youremail@domain.com"
-```
-
-3. Install Node.js, nvm, yarn
-```bash
-sudo apt-get install curl
-curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
-corepack enable
-```
-Close and reopen your terminal to start using nvm.
-
-
-
-
----
-
-## Step 1: Git Clone
-
-In your terminal, run the following command.
-
-
-
-
-If you haven't already set up SSH keys, you can learn how to do so [here](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/about-ssh).
-```bash
-git clone git@github.com:twentyhq/twenty.git
-```
-
-
-
-```bash
-git clone https://github.com/twentyhq/twenty.git
-```
-
-
-
-
-## Step 2: Position yourself at the root
-
-```bash
-cd twenty
-```
-
-You should run all commands in the following steps from the root of the project.
-
-## Step 3: Set up a PostgreSQL Database
-We rely on [pg_graphql](https://github.com/supabase/pg_graphql) and recommend you use the scripts below to provision a database with the right extensions.
-You can access the database at [localhost:5432](localhost:5432), with user `twenty` and password `twenty` .
-
-
-
- Option 1: To provision your database locally:
- ```bash
- make postgres-on-linux
- ```
-
- Option 2: If you have docker installed:
- ```bash
- make postgres-on-docker
- ```
-
-
- Option 1: To provision your database locally with `brew`:
- ```bash
- make postgres-on-macos-intel #for intel architecture
- make postgres-on-macos-arm #for M1/M2/M3 architecture
- ```
-
- Option 2: If you have docker installed:
- ```bash
- make postgres-on-docker
- ```
-
-
- Option 1 : To provision your database locally:
- ```bash
- make postgres-on-linux
- ```
-
- Note: you might need to run `sudo apt-get install build-essential` before running the above command if you don't have the build tools installed.
-
- Option 2: If you have docker installed:
- Running Docker on WSL adds an extra layer of complexity.
- Only use this option if you are comfortable with the extra steps involved, including turning on [Docker Desktop WSL2](https://docs.docker.com/desktop/wsl).
- ```bash
- make postgres-on-docker
- ```
-
-
-
-
-## Step 4: Setup environment variables
-
-Use environment variables or `.env` files to configure your project.
-
-Copy the `.env.example` files in `/front` and `/server`:
-```bash
-cp ./packages/twenty-front/.env.example ./packages/twenty-front/.env
-cp ./packages/twenty-server/.env.example ./packages/twenty-server/.env
-```
-
-## Step 5: Installing dependencies
-
-:::info
-
-Use `nvm` to install the correct `node` version. The `.nvmrc` ensures all contributors use the same version.
-
-:::
-
-To build Twenty server and seed some data into your database, run the following commands:
-```bash
-nvm install # installs recommended node version
-nvm use # use recommended node version
-
-yarn
-```
-
-## Step 6: Running the project
-
-Setup your database with the following command:
-```bash
-npx nx database:reset twenty-server
-```
-
-Start the server and the frontend:
-```bash
-npx nx start twenty-server
-npx nx start twenty-front
-```
-
-Alternatively, you can start both applications at once:
-```bash
-npx nx start
-```
-
-Twenty's server will be up and running at [http://localhost:3000/graphql](http://localhost:3000/graphql).
-Twenty's frontend will be running at [http://localhost:3001](http://localhost:3001). Just login using the seeded demo account: `tim@apple.dev` (password: `Applecar2025`) to start using Twenty.
-
-
-## Troubleshooting
-
-#### CR line breaks found [Windows]
-
-This is due to the line break characters of Windows and the git configuration. Try running:
-
-```
-git config --global core.autocrlf false
-```
-
-Then delete the repository and clone it again.
-
-#### Missing metadata schema
-
-During Twenty installation, you need to provision your postgres database with the right schemas, extensions, and users.
-If you're successful in running this provisioning, you should have `default` and `metadata` schemas in your database.
-If you don't, make sure you don't have more than one postgres instance running on your computer.
-
-#### Cannot find module 'twenty-emails' or its corresponding type declarations.
-
-You have to build the package `twenty-emails` before running the initialization of the database with `npx nx run twenty-emails:build`
-
-#### Missing twenty-x package
-
-Make sure to run yarn in the root directory and then run `npx nx server:dev twenty-server`. If this still doesn't work try building the missing package manually.
-
-#### Lint on Save not working
-
-This should work out of the box with the eslint extension installed. If this doens't work try adding this to your vscode setting (on the dev container scope):
-
-```
-"editor.codeActionsOnSave": {
- "source.fixAll.eslint": "explicit"
-}
-```
-
-#### Docker container build
-
-To successfully build Docker images, ensure that your system has a minimum of 2GB of memory available. For users of Docker Desktop, please verify that you've allocated sufficient resources to Docker within the application's settings.
diff --git a/packages/twenty-docs/docs/start/self-hosting/_category_.json b/packages/twenty-docs/docs/start/self-hosting/_category_.json
deleted file mode 100644
index 254ec2489..000000000
--- a/packages/twenty-docs/docs/start/self-hosting/_category_.json
+++ /dev/null
@@ -1,5 +0,0 @@
-{
- "position": 3,
- "collapsible": true,
- "collapsed": true
-}
diff --git a/packages/twenty-docs/docs/start/self-hosting/cloud-providers.mdx b/packages/twenty-docs/docs/start/self-hosting/cloud-providers.mdx
deleted file mode 100644
index 8e40ade6b..000000000
--- a/packages/twenty-docs/docs/start/self-hosting/cloud-providers.mdx
+++ /dev/null
@@ -1,437 +0,0 @@
----
-title: Vendor-specific instructions
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbCloud
----
-
-:::info
-This document is maintained by the community. It might contain issues.
-Feel free to join our discord if you need assistance.
-:::
-
-
-## Render
-
-[](https://render.com/deploy?repo=https://github.com/twentyhq/twenty)
-
-## RepoCloud
-
-[](https://repocloud.io/details/?app_id=259)
-
-
-## Azure Container Apps
-
-### About
-
-Hosts Twenty CRM using Azure Container Apps.
-The solution provisions file shares, a container apps environment with three containers, and a log analytics workspace.
-
-The file shares are used to store uploaded images and files through the UI, and to store database backups.
-
-### Prerequisites
-
-- Terraform installed https://developer.hashicorp.com/terraform/install
-- An Azure subscription with permissions to create resources
-
-### Step by step instructions:
-
-1. Create a new folder and copy all the files from below
-2. Run `terraform init`
-3. Run `terraform plan -out tfplan`
-4. Run `terraform apply tfplan`
-5. Connect to server `az containerapp exec --name twenty-server -g twenty-crm-rg`
-6. Initialize the database from the server `yarn database:init:prod`
-7. Go to https://your-twenty-front-fqdn - located in the portal
-
-#### Production docker containers
-
-This uses the prebuilt images found on [docker hub](https://hub.docker.com/r/twentycrm/).
-
-#### Environment Variables
-
-- Is set in respective tf-files
-- See docs [Setup Environment Variables](https://docs.twenty.com/start/self-hosting/) for usage
-- After deployment you could can set `IS_SIGN_UP_DISABLED=true` (and run `terraform plan/apply` again) to disable new workspaces from being created
-
-#### Security and networking
-
-- Container `twenty-db` accepts only ingress TCP traffic from other containers in the environment. No external ingress traffic allowed
-- Container `twenty-server` accepts external traffic over HTTPS
-- Container `twenty-front` accepts external traffic over HTTPS
-
-It´s highly recommended to enable [built-in authentication](https://learn.microsoft.com/en-us/azure/container-apps/authentication) for `twenty-front` using one of the supported providers.
-
-Use the [custom domain](https://learn.microsoft.com/en-us/azure/container-apps/custom-domains-certificates) feature on the `twenty-front` container if you would like an easier domain name.
-
-#### Files
-
-##### providers.tf
-
-```hcl
-# providers.tf
-
-terraform {
- required_providers {
- azapi = {
- source = "Azure/azapi"
- }
- }
-}
-
-provider "azapi" {
-}
-
-provider "azurerm" {
- features {}
-}
-
-provider "azuread" {
-}
-
-provider "random" {
-}
-```
-
-##### main.tf
-
-```hcl
-# main.tf
-
-# Create a resource group
-resource "azurerm_resource_group" "main" {
- name = "twenty-crm-rg"
- location = "North Europe"
-}
-
-# Variables
-locals {
- app_env_name = "twenty"
-
- server_name = "twenty-server"
- server_tag = "latest"
-
- front_app_name = "twenty-front"
- front_tag = "latest"
-
- db_app_name = "twenty-postgres"
- db_tag = "latest"
-
- db_user = "twenty"
- db_password = "twenty"
-
- storage_mount_db_name = "twentydbstoragemount"
- storage_mount_server_name = "twentyserverstoragemount"
-
- cpu = 1.0
- memory = "2Gi"
-}
-
-# Set up a Log Analytics workspace
-resource "azurerm_log_analytics_workspace" "main" {
- name = "${local.app_env_name}-law"
- location = azurerm_resource_group.main.location
- resource_group_name = azurerm_resource_group.main.name
- sku = "PerGB2018"
- retention_in_days = 30
-}
-
-# Create a storage account
-resource "random_pet" "example" {
- length = 2
- separator = ""
-}
-
-resource "azurerm_storage_account" "main" {
- name = "twentystorage${random_pet.example.id}"
- resource_group_name = azurerm_resource_group.main.name
- location = azurerm_resource_group.main.location
- account_tier = "Standard"
- account_replication_type = "LRS"
- large_file_share_enabled = true
-}
-
-# Create db file storage
-resource "azurerm_storage_share" "db" {
- name = "twentydatabaseshare"
- storage_account_name = azurerm_storage_account.main.name
- quota = 50
- enabled_protocol = "SMB"
-}
-
-# Create backend file storage
-resource "azurerm_storage_share" "server" {
- name = "twentyservershare"
- storage_account_name = azurerm_storage_account.main.name
- quota = 50
- enabled_protocol = "SMB"
-}
-
-# Create a Container App Environment
-resource "azurerm_container_app_environment" "main" {
- name = "${local.app_env_name}-env"
- location = azurerm_resource_group.main.location
- resource_group_name = azurerm_resource_group.main.name
- log_analytics_workspace_id = azurerm_log_analytics_workspace.main.id
-}
-
-# Connect the db storage share to the container app environment
-resource "azurerm_container_app_environment_storage" "db" {
- name = local.storage_mount_db_name
- container_app_environment_id = azurerm_container_app_environment.main.id
- account_name = azurerm_storage_account.main.name
- share_name = azurerm_storage_share.db.name
- access_key = azurerm_storage_account.main.primary_access_key
- access_mode = "ReadWrite"
-}
-
-# Connect the server storage share to the container app environment
-resource "azurerm_container_app_environment_storage" "server" {
- name = local.storage_mount_server_name
- container_app_environment_id = azurerm_container_app_environment.main.id
- account_name = azurerm_storage_account.main.name
- share_name = azurerm_storage_share.server.name
- access_key = azurerm_storage_account.main.primary_access_key
- access_mode = "ReadWrite"
-}
-```
-
-##### frontend.tf
-
-```hcl
-# frontend.tf
-
-resource "azurerm_container_app" "twenty_front" {
- name = local.front_app_name
- container_app_environment_id = azurerm_container_app_environment.main.id
- resource_group_name = azurerm_resource_group.main.name
- revision_mode = "Single"
-
- depends_on = [azurerm_container_app.twenty_server]
-
- ingress {
- allow_insecure_connections = false
- external_enabled = true
- target_port = 3000
- transport = "http"
- traffic_weight {
- percentage = 100
- latest_revision = true
- }
- }
-
- template {
- min_replicas = 1
- # things starts to fail when using more than 1 replica
- max_replicas = 1
- container {
- name = "twenty-front"
- image = "docker.io/twentycrm/twenty-front:${local.front_tag}"
- cpu = local.cpu
- memory = local.memory
-
- env {
- name = "REACT_APP_SERVER_BASE_URL"
- value = "https://${azurerm_container_app.twenty_server.ingress[0].fqdn}"
- }
- }
- }
-}
-
-# Set CORS rules for frontend app using AzAPI
-resource "azapi_update_resource" "cors" {
- type = "Microsoft.App/containerApps@2023-05-01"
- resource_id = azurerm_container_app.twenty_front.id
- body = jsonencode({
- properties = {
- configuration = {
- ingress = {
- corsPolicy = {
- allowedOrigins = ["*"]
- }
- }
- }
- }
- })
- depends_on = [azurerm_container_app.twenty_front]
-}
-```
-
-##### backend.tf
-
-```hcl
-# backend.tf
-
-# Create three random UUIDs
-resource "random_uuid" "access_token_secret" {}
-resource "random_uuid" "login_token_secret" {}
-resource "random_uuid" "refresh_token_secret" {}
-resource "random_uuid" "file_token_secret" {}
-
-resource "azurerm_container_app" "twenty_server" {
- name = local.server_name
- container_app_environment_id = azurerm_container_app_environment.main.id
- resource_group_name = azurerm_resource_group.main.name
- revision_mode = "Single"
-
- depends_on = [azurerm_container_app.twenty_db, azurerm_container_app_environment_storage.server]
-
- ingress {
- allow_insecure_connections = false
- external_enabled = true
- target_port = 3000
- transport = "http"
- traffic_weight {
- percentage = 100
- latest_revision = true
- }
- }
-
- template {
- min_replicas = 1
- max_replicas = 1
- volume {
- name = "twenty-server-data"
- storage_type = "AzureFile"
- storage_name = local.storage_mount_server_name
- }
-
- container {
- name = local.server_name
- image = "docker.io/twentycrm/twenty-server:${local.server_tag}"
- cpu = local.cpu
- memory = local.memory
-
- volume_mounts {
- name = "twenty-server-data"
- path = "/app/packages/twenty-server/.local-storage"
- }
-
- # Environment variables
- env {
- name = "IS_SIGN_UP_DISABLED"
- value = false
- }
- env {
- name = "SIGN_IN_PREFILLED"
- value = false
- }
- env {
- name = "STORAGE_TYPE"
- value = "local"
- }
- env {
- name = "STORAGE_LOCAL_PATH"
- value = ".local-storage"
- }
- env {
- name = "PG_DATABASE_URL"
- value = "postgres://${local.db_user}:${local.db_password}@${local.db_app_name}:5432/default"
- }
- env {
- name = "FRONT_BASE_URL"
- value = "https://${local.front_app_name}"
- }
- env {
- name = "ACCESS_TOKEN_SECRET"
- value = random_uuid.access_token_secret.result
- }
- env {
- name = "LOGIN_TOKEN_SECRET"
- value = random_uuid.login_token_secret.result
- }
- env {
- name = "REFRESH_TOKEN_SECRET"
- value = random_uuid.refresh_token_secret.result
- }
- env {
- name = "FILE_TOKEN_SECRET"
- value = random_uuid.file_token_secret.result
- }
- }
- }
-}
-
-# Set CORS rules for server app using AzAPI
-resource "azapi_update_resource" "server_cors" {
- type = "Microsoft.App/containerApps@2023-05-01"
- resource_id = azurerm_container_app.twenty_server.id
- body = jsonencode({
- properties = {
- configuration = {
- ingress = {
- corsPolicy = {
- allowedOrigins = ["*"]
- }
- }
- }
- }
- })
- depends_on = [azurerm_container_app.twenty_server]
-}
-```
-
-##### database.tf
-
-```hcl
-# database.tf
-
-resource "azurerm_container_app" "twenty_db" {
- name = local.db_app_name
- container_app_environment_id = azurerm_container_app_environment.main.id
- resource_group_name = azurerm_resource_group.main.name
- revision_mode = "Single"
-
- depends_on = [azurerm_container_app_environment_storage.db]
-
- ingress {
- allow_insecure_connections = false
- external_enabled = false
- target_port = 5432
- transport = "tcp"
- traffic_weight {
- percentage = 100
- latest_revision = true
- }
- }
-
- template {
- min_replicas = 1
- max_replicas = 1
- container {
- name = local.db_app_name
- image = "docker.io/twentycrm/twenty-postgres:${local.db_tag}"
- cpu = local.cpu
- memory = local.memory
-
- volume_mounts {
- name = "twenty-db-data"
- path = "/var/lib/postgresql/data"
- }
-
- env {
- name = "POSTGRES_USER"
- value = "postgres"
- }
- env {
- name = "POSTGRES_PASSWORD"
- value = "postgres"
- }
- env {
- name = "POSTGRES_DB"
- value = "default"
- }
- }
-
- volume {
- name = "twenty-db-data"
- storage_type = "AzureFile"
- storage_name = local.storage_mount_db_name
- }
- }
-}
-```
-
-## Others
-
-Please feel free to Open a PR to add more Cloud Provider options.
diff --git a/packages/twenty-docs/docs/start/self-hosting/docker-compose.mdx b/packages/twenty-docs/docs/start/self-hosting/docker-compose.mdx
deleted file mode 100644
index 3cbf57ad9..000000000
--- a/packages/twenty-docs/docs/start/self-hosting/docker-compose.mdx
+++ /dev/null
@@ -1,58 +0,0 @@
----
-title: Docker Compose (easy)
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbBrandDocker
----
-# Step by step instructions:
-
-## One command installation
-
-Install the project with the command below. By default, it installs the latest version from the main branch.
-```bash
-bash <(curl -sL https://git.new/20)
-```
-
-## Custom Installation:
-
-Set VERSION for a specific docker image version, BRANCH for a specific clone branch:
-```bash
-VERSION=x.y.z BRANCH=branch-name bash <(curl -sL https://git.new/20)
-```
-
-## Manual installation
-
-1. Copy the [.env.example](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/.env.example) into a `.env` in the same directory where your `docker-compose.yml` file will be
-2. Run the command `openssl rand -base64 32` four times, make note of the string for each
-3. In your .env file, replace the three "replace_me_with_a_random_string_access" with the four random strings you just generated.
-
-```
-ACCESS_TOKEN_SECRET=replace_me_with_a_random_string_access
-LOGIN_TOKEN_SECRET=replace_me_with_a_random_string_login
-REFRESH_TOKEN_SECRET=replace_me_with_a_random_string_refresh
-FILE_TOKEN_SECRET=replace_me_with_a_random_string_refresh
-```
-
-4. Copy the [docker-compose.yml](https://github.com/twentyhq/twenty/blob/main/packages/twenty-docker/docker-compose.yml) in the same directory as your `.env` file.
-5. Run the command `docker-compose up -d`
-6. Go to http://localhost:3000 and see your docker instance.
-
-## Troubleshooting
-
-### Not able to login
-
-If you encounter errors, (not able to log into the application after inputting an email) after the inital setup, try running the following commands and see if that solves your issue.
-```
-docker exec -it twenty-server-1 yarn
-docker exec -it twenty-server-1 npx nx database:reset
-```
-
-### Cannot connect to server, running behind a reverse proxy
-
-Complete step three and four with:
-
-3. Update `SERVER_URL=https://` in your `.env`
-
-### Persistence
-
-By default the docker-compose will create volumes for the Database and local storage of the Server. Note that the containers will not persist data if your server is not configured to be stateful (for example Heroku). You probably want to configure a special stateful resource for this purpose.
diff --git a/packages/twenty-docs/docs/start/self-hosting/self-hosting.mdx b/packages/twenty-docs/docs/start/self-hosting/self-hosting.mdx
deleted file mode 100644
index 13b2aff38..000000000
--- a/packages/twenty-docs/docs/start/self-hosting/self-hosting.mdx
+++ /dev/null
@@ -1,220 +0,0 @@
----
-title: Self-Hosting
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbServer
----
-
-
-import DocCardList from '@theme/DocCardList';
-
-import OptionTable from '@site/src/theme/OptionTable'
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-
-
-# Setup Server
-
-
-
-# Setup Messaging & Calendar sync
-
-Twenty offers integrations with Gmail and Google Calendar. To enable these features, you need to connect to register the following recurring jobs:
-```
-# from your worker container
-yarn command:prod cron:messaging:messages-import
-yarn command:prod cron:messaging:message-list-fetch
-```
-
-# Setup Environment Variables
-
-## Frontend
-
-
-
-
-## Backend
-
-### Config
-
-
-
-### Security
-
-
-### Tokens
-
-', 'Secret used for the access tokens'],
- ['ACCESS_TOKEN_EXPIRES_IN', '30m', 'Access token expiration time'],
- ['LOGIN_TOKEN_SECRET', '', 'Secret used for the login tokens'],
- ['LOGIN_TOKEN_EXPIRES_IN', '15m', 'Login token expiration time'],
- ['REFRESH_TOKEN_SECRET', '', 'Secret used for the refresh tokens'],
- ['REFRESH_TOKEN_EXPIRES_IN', '90d', 'Refresh token expiration time'],
- ['REFRESH_TOKEN_COOL_DOWN', '1m', 'Refresh token cooldown'],
- ['FILE_TOKEN_SECRET', '', 'Secret used for the file tokens'],
- ['FILE_TOKEN_EXPIRES_IN', '1d', 'File token expiration time'],
- ['API_TOKEN_EXPIRES_IN', '1000y', 'Api token expiration time'],
- ]}>
-
-### Auth
-
-
-
-### Email
-
-
-
-#### Email SMTP Server configuration examples
-
-
-
-
-
- You will need to provision an [App Password](https://support.google.com/accounts/answer/185833).
- - EMAIL_SMTP_HOST=smtp.gmail.com
- - EMAIL_SMTP_PORT=465
- - EMAIL_SMTP_USER=gmail_email_address
- - EMAIL_SMTP_PASSWORD='gmail_app_password'
-
-
-
-
-
- Keep in mind that if you have 2FA enabled, you will need to provision an [App Password](https://support.microsoft.com/en-us/account-billing/manage-app-passwords-for-two-step-verification-d6dc8c6d-4bf7-4851-ad95-6d07799387e9).
- - EMAIL_SMTP_HOST=smtp.office365.com
- - EMAIL_SMTP_PORT=587
- - EMAIL_SMTP_USER=office365_email_address
- - EMAIL_SMTP_PASSWORD='office365_password'
-
-
-
-
-
- **smtp4dev** is a fake SMTP email server for development and testing.
- - Run the smtp4dev image: `docker run --rm -it -p 8090:80 -p 2525:25 rnwood/smtp4dev`
- - Access the smtp4dev ui here: [http://localhost:8090](http://localhost:8090)
- - Set the following env variables:
- - EMAIL_SMTP_HOST=localhost
- - EMAIL_SMTP_PORT=2525
-
-
-
-
-
-### Storage
-
-
-
-### Message Queue
-
-
-
-### Logging
-
-
-
-
-### Data enrichment and AI
-
-
-
-
-### Support Chat
-
-', 'Suport chat key'],
- ['SUPPORT_FRONT_CHAT_ID', '', 'Support chat id'],
- ]}>
-
-### Telemetry
-
-
-
-### Debug / Development
-
-
-
-### Workspace Cleaning
-
-
-
-### Captcha
-
-
diff --git a/packages/twenty-docs/docs/start/self-hosting/upgrade-guide.mdx b/packages/twenty-docs/docs/start/self-hosting/upgrade-guide.mdx
deleted file mode 100644
index 0afcf554d..000000000
--- a/packages/twenty-docs/docs/start/self-hosting/upgrade-guide.mdx
+++ /dev/null
@@ -1,8 +0,0 @@
----
-title: Upgrade guide
-sidebar_position: 4
-sidebar_class_name: coming-soon
-sidebar_custom_props:
- icon: TbServer
----
-
diff --git a/packages/twenty-docs/docs/ui-components/_category_.json b/packages/twenty-docs/docs/ui-components/_category_.json
deleted file mode 100644
index 89ff27960..000000000
--- a/packages/twenty-docs/docs/ui-components/_category_.json
+++ /dev/null
@@ -1,4 +0,0 @@
-{
- "label": "UI Components",
- "position": 1
-}
diff --git a/packages/twenty-docs/docs/ui-components/display/_category_.json b/packages/twenty-docs/docs/ui-components/display/_category_.json
deleted file mode 100644
index 02fc981b5..000000000
--- a/packages/twenty-docs/docs/ui-components/display/_category_.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "label": "Display",
- "position": 1,
- "collapsible": true,
- "collapsed": false,
- "customProps": {
- "icon": "TbAppWindow"
- }
-}
diff --git a/packages/twenty-docs/docs/ui-components/display/app-tooltip.mdx b/packages/twenty-docs/docs/ui-components/display/app-tooltip.mdx
deleted file mode 100644
index 95636c512..000000000
--- a/packages/twenty-docs/docs/ui-components/display/app-tooltip.mdx
+++ /dev/null
@@ -1,139 +0,0 @@
----
-title: App Tooltip
-sidebar_position: 6
-sidebar_custom_props:
- icon: TbTooltip
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import appTooltipCode from '!!raw-loader!@site/src/ui/display/appTooltipCode.js'
-import overflowingTextWithTooltipCode from '!!raw-loader!@site/src/ui/display/overflowingTextWithTooltipCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-A brief message that displays additional information when a user interacts with an element.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
className
-
string
-
Optional CSS class for additional styling
-
-
-
-
anchorSelect
-
CSS selector
-
Selector for the tooltip anchor (the element that triggers the tooltip)
-
-
-
-
content
-
string
-
The content you want to display within the tooltip
-
-
-
-
delayHide
-
number
-
The delay in seconds before hiding the tooltip after the cursor leaves the anchor
-
-
-
-
offset
-
number
-
The offset in pixels for positioning the tooltip
-
-
-
-
noArrow
-
boolean
-
If `true`, hides the arrow on the tooltip
-
-
-
-
isOpen
-
boolean
-
If `true`, the tooltip is open by default
-
-
-
-
place
-
`PlacesType` string from `react-tooltip`
-
Specifies the placement of the tooltip. Values include `bottom`, `left`, `right`, `top`, `top-start`, `top-end`, `right-start`, `right-end`, `bottom-start`, `bottom-end`, `left-start`, and `left-end`
-
-
-
-
positionStrategy
-
`PositionStrategy` string from `react-tooltip`
-
Position strategy for the tooltip. Has two values: `absolute` and `fixed`
-
-
-
-
-
-
-
-
-
-
-## Overflowing Text with Tooltip
-
-Handles overflowing text and displays a tooltip when the text overflows.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
text
-
string
-
The content you want to display in the overflowing text area
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/display/checkmark.mdx b/packages/twenty-docs/docs/ui-components/display/checkmark.mdx
deleted file mode 100644
index 621437830..000000000
--- a/packages/twenty-docs/docs/ui-components/display/checkmark.mdx
+++ /dev/null
@@ -1,95 +0,0 @@
----
-title: Checkmark
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbCheck
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import checkmarkCode from '!!raw-loader!@site/src/ui/display/checkmarkCode.js'
-import animatedCheckmarkCode from '!!raw-loader!@site/src/ui/display/animatedCheckmarkCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-Represents a successful or completed action.
-
-
-
-
-
-
-
-
-
-
-Extends `React.ComponentPropsWithoutRef<'div'>` and accepts all the props of a regular `div` element.
-
-
-
-
-
-## Animated Checkmark
-
-Represents a checkmark icon with the added feature of animation.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
isAnimating
-
boolean
-
Controls whether the checkmark is animating
-
`false`
-
-
-
-
color
-
string
-
Color of the checkmark
-
Theme's gray0
-
-
-
-
duration
-
number
-
The duration of the animation in seconds
-
0.5 seconds
-
-
-
-
size
-
number
-
The size of the checkmark
-
28 pixels
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/display/chip.mdx b/packages/twenty-docs/docs/ui-components/display/chip.mdx
deleted file mode 100644
index f8040b915..000000000
--- a/packages/twenty-docs/docs/ui-components/display/chip.mdx
+++ /dev/null
@@ -1,252 +0,0 @@
----
-title: Chip
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbLayoutList
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import chipCode from '!!raw-loader!@site/src/ui/display/chipCode.js'
-import entityChipCode from '!!raw-loader!@site/src/ui/display/entityChipCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-A visual element that you can use as a clickable or non-clickable container with a label, optional left and right components, and various styling options to display labels and tags.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
size
-
`ChipSize` enum
-
Specifies the size of the chip. Has two options: `large` and `small`
-
small
-
-
-
-
disabled
-
boolean
-
Indicates whether the chip is disabled
-
false
-
-
-
-
clickable
-
boolean
-
Specifies whether the chip is clickable
-
true
-
-
-
-
label
-
string
-
Represents the text content or label inside the chip
-
-
-
-
-
maxWidth
-
string
-
Specifies the maximum width of the chip
-
200px
-
-
-
-
variant
-
`ChipVariant` enum
-
Specifies the visual style or variant of the chip. Has four options: `regular`, `highlighted`, `transparent`, and `rounded`
-
regular
-
-
-
-
accent
-
`ChipAccent` enum
-
Determines the text color or accent color of the chip. Has two options: `text-primary` and `text-secondary`
-
text-primary
-
-
-
-
leftComponent
-
`React.ReactNode`
-
An optional React/node component that you can place on the left side of the chip
-
-
-
-
-
rightComponent
-
`React.ReactNode`
-
An optional React/node component that you can place on the right side of the chip
-
-
-
-
-
className
-
string
-
An optional class name to apply additional custom styles to the chip
The type of avatar you want to display. Has two options: `rounded` and `squared`
-
rounded
-
-
-
-
variant
-
`EntityChipVariant` enum
-
Variant of the entity chip you want to display. Has two options: `regular` and `transparent`
-
regular
-
-
-
-
LeftIcon
-
IconComponent
-
A React component representing an icon. Displayed on the left side of the chip
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/display/icons.mdx b/packages/twenty-docs/docs/ui-components/display/icons.mdx
deleted file mode 100644
index 222cf7ab1..000000000
--- a/packages/twenty-docs/docs/ui-components/display/icons.mdx
+++ /dev/null
@@ -1,134 +0,0 @@
----
-title: Icons
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbIcons
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import tablerIconExampleCode from '!!raw-loader!@site/src/ui/display/tablerIconExampleCode.js'
-import iconAddressBookCode from '!!raw-loader!@site/src/ui/display/iconAddressBookCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-A list of icons used throughout our app.
-
-## Tabler Icons
-
-We use Tabler icons for React throughout the app.
-
-
-
-
-
-```
-yarn add @tabler/icons-react
-```
-
-
-
-
-
-You can import each icon as a component. Here's an example:
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
size
-
number
-
The height and width of the icon in pixels
-
24
-
-
-
-
color
-
string
-
The color of the icons
-
currentColor
-
-
-
-
stroke
-
number
-
The stroke width of the icon in pixels
-
2
-
-
-
-
-
-
-
-
-
-
-## Custom Icons
-
-In addition to Tabler icons, the app also uses some custom icons.
-
-### Icon Address Book
-
-Displays an address book icon.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
size
-
number
-
The height and width of the icon in pixels
-
24
-
-
-
-
stroke
-
number
-
The stroke width of the icon in pixels
-
2
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/display/soon-pill.mdx b/packages/twenty-docs/docs/ui-components/display/soon-pill.mdx
deleted file mode 100644
index 3c8e7febe..000000000
--- a/packages/twenty-docs/docs/ui-components/display/soon-pill.mdx
+++ /dev/null
@@ -1,49 +0,0 @@
----
-title: Soon Pill
-sidebar_position: 4
-sidebar_custom_props:
- icon: TbPill
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import soonPillCode from '!!raw-loader!@site/src/ui/display/soonPillCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-A small badge or "pill" to indicate something is coming soon.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
diff --git a/packages/twenty-docs/docs/ui-components/display/tag.mdx b/packages/twenty-docs/docs/ui-components/display/tag.mdx
deleted file mode 100644
index 1303b574c..000000000
--- a/packages/twenty-docs/docs/ui-components/display/tag.mdx
+++ /dev/null
@@ -1,68 +0,0 @@
----
-title: Tag
-sidebar_position: 5
-sidebar_custom_props:
- icon: TbTag
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import tagCode from '!!raw-loader!@site/src/ui/display/tagCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-Component to visually categorize or label content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
color
-
string
-
Color of the tag. Options include: `green`, `turquoise`, `sky`, `blue`, `purple`, `pink`, `red`, `orange`, `yellow`, `gray`
-
-
-
-
text
-
string
-
The content of the tag
-
-
-
-
onClick
-
function
-
Optional function called when a user clicks on the tag
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/feedback/_category_.json b/packages/twenty-docs/docs/ui-components/feedback/_category_.json
deleted file mode 100644
index bb7023e29..000000000
--- a/packages/twenty-docs/docs/ui-components/feedback/_category_.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "label": "Feedback",
- "position": 2,
- "collapsible": true,
- "collapsed": false,
- "customProps": {
- "icon": "TbForms"
- }
-}
diff --git a/packages/twenty-docs/docs/ui-components/feedback/progress-bar.mdx b/packages/twenty-docs/docs/ui-components/feedback/progress-bar.mdx
deleted file mode 100644
index 54ea0e15e..000000000
--- a/packages/twenty-docs/docs/ui-components/feedback/progress-bar.mdx
+++ /dev/null
@@ -1,143 +0,0 @@
----
-title: Progress Bar
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbLoader2
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import progressBarCode from '!!raw-loader!@site/src/ui/feedback/progressBarCode.js'
-import circularProgressBarCode from '!!raw-loader!@site/src/ui/feedback/circularProgressBarCode.js'
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-Indicates progress or countdown and moves from right to left.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
duration
-
number
-
The total duration of the progress bar animation in milliseconds
-
3
-
-
-
-
delay
-
number
-
The delay in starting the progress bar animation in milliseconds
-
0
-
-
-
-
easing
-
string
-
Easing function for the progress bar animation
-
easeInOut
-
-
-
-
barHeight
-
number
-
The height of the bar in pixels
-
24
-
-
-
-
barColor
-
string
-
The color of the bar
-
gray80
-
-
-
-
autoStart
-
boolean
-
If `true`, the progress bar animation starts automatically when the component mounts
-
`true`
-
-
-
-
-
-
-
-
-
-## Circular Progress Bar
-
-Indicates the progress of a task, often used in loading screens or areas where you want to communicate ongoing processes to the user.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
size
-
number
-
The size of the circular progress bar
-
50
-
-
-
-
barWidth
-
number
-
The width of the progress bar line
-
5
-
-
-
-
barColor
-
string
-
The color of the progress bar
-
currentColor
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/_category_.json b/packages/twenty-docs/docs/ui-components/input/_category_.json
deleted file mode 100644
index c354b365b..000000000
--- a/packages/twenty-docs/docs/ui-components/input/_category_.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "label": "Input",
- "position": 3,
- "collapsible": true,
- "collapsed": false,
- "customProps": {
- "icon": "TbInputSearch"
- }
-}
diff --git a/packages/twenty-docs/docs/ui-components/input/block-editor.mdx b/packages/twenty-docs/docs/ui-components/input/block-editor.mdx
deleted file mode 100644
index 88a7060e6..000000000
--- a/packages/twenty-docs/docs/ui-components/input/block-editor.mdx
+++ /dev/null
@@ -1,46 +0,0 @@
----
-title: Block Editor
-sidebar_position: 11
-sidebar_custom_props:
- icon: TbTemplate
----
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import blockEditorCode from '!!raw-loader!@site/src/ui/input/blockEditorCode.js'
-
-Uses a block-based rich text editor from [BlockNote](https://www.blocknotejs.org/) to allow users to edit and view blocks of content.
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
editor
-
`BlockNoteEditor`
-
The block editor instance or configuration
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/button.mdx b/packages/twenty-docs/docs/ui-components/input/button.mdx
deleted file mode 100644
index 1ab481b08..000000000
--- a/packages/twenty-docs/docs/ui-components/input/button.mdx
+++ /dev/null
@@ -1,795 +0,0 @@
----
-title: Buttons
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbSquareRoundedPlusFilled
----
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import buttonCode from '!!raw-loader!@site/src/ui/input/button/buttonCode.js'
-import buttonGroupCode from '!!raw-loader!@site/src/ui/input/button/buttonGroupCode.js'
-import floatingButtonCode from '!!raw-loader!@site/src/ui/input/button/floatingButtonCode.js'
-import floatingButtonGroupCode from '!!raw-loader!@site/src/ui/input/button/floatingButtonGroupCode.js'
-import floatingIconButtonCode from '!!raw-loader!@site/src/ui/input/button/floatingIconButtonCode.js'
-import floatingIconButtonGroupCode from '!!raw-loader!@site/src/ui/input/button/floatingIconButtonGroupCode.js'
-import lightButtonCode from '!!raw-loader!@site/src/ui/input/button/lightButtonCode.js'
-import lightIconButtonCode from '!!raw-loader!@site/src/ui/input/button/lightIconButtonCode.js'
-import mainButtonCode from '!!raw-loader!@site/src/ui/input/button/mainButtonCode.js'
-import roundedIconButtonCode from '!!raw-loader!@site/src/ui/input/button/roundedIconButtonCode.js'
-
-A list of buttons and button groups used throughout the app.
-
-## Button
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
className
-
string
-
Optional class name for additional styling
-
-
-
-
-
Icon
-
`React.ComponentType`
-
An optional icon component that's displayed within the button
-
-
-
-
-
title
-
string
-
The text content of the button
-
-
-
-
-
fullWidth
-
boolean
-
Defines whether the button should span the whole width of its container
-
`false`
-
-
-
-
variant
-
string
-
The visual style variant of the button. Options include `primary`, `secondary`, and `tertiary`
-
primary
-
-
-
-
size
-
string
-
The size of the button. Has two options: `small` and `medium`
-
medium
-
-
-
-
position
-
string
-
The position of the button in relation to its siblings. Options include: `standalone`, `left`, `right`, and `middle`
-
standalone
-
-
-
-
accent
-
string
-
The accent color of the button. Options include: `default`, `blue`, and `danger`
-
default
-
-
-
-
soon
-
boolean
-
Indicates if the button is marked as "soon" (such as for upcoming features)
-
`false`
-
-
-
-
disabled
-
boolean
-
Specifies whether button is disabled or not
-
`false`
-
-
-
-
focus
-
boolean
-
Determines if the button has focus
-
`false`
-
-
-
-
onClick
-
function
-
A callback function that triggers when the user clicks on the button
-
-
-
-
-
-
-
-
-
-
-## Button Group
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
variant
-
string
-
The visual style variant of the buttons within the group. Options include `primary`, `secondary`, and `tertiary`
-
-
-
-
size
-
string
-
The size of the buttons within the group. Has two options: `medium` and `small`
-
-
-
-
accent
-
string
-
The accent color of the buttons within the group. Options include `default`, `blue` and `danger`
-
-
-
-
className
-
string
-
Optional class name for additional styling
-
-
-
-
children
-
ReactNode
-
An array of React elements representing the individual buttons within the group
The size of the button. Has two options: `small` and `medium`
-
-
-
-
iconButtons
-
array
-
An array of objects, each representing an icon button in the group. Each object should include the icon component you want to display in the button, the function you want to call when a user clicks on the button, and whether the button should be active or not.
-
-
-
-
-
-
-
-
-
-## Light Button
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
icon
-
`React.ReactNode`
-
The icon you want to display in the button
-
-
-
-
-
title
-
string
-
The text content of the button
-
-
-
-
-
accent
-
string
-
The accent color of the button. Options include: `secondary` and `tertiary`
-
secondary
-
-
-
-
active
-
boolean
-
Determines if the button is in an active state
-
`false`
-
-
-
-
disabled
-
boolean
-
Determines whether the button is disabled
-
`false`
-
-
-
-
focus
-
boolean
-
Indicates if the button has focus
-
`false`
-
-
-
-
onClick
-
function
-
A callback function that triggers when the user clicks on the button
An optional icon component that's displayed within the button
-
-
-
-
React `button` props
-
`React.ButtonHTMLAttributes`
-
Additional props from React's `button` element
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/checkbox.mdx b/packages/twenty-docs/docs/ui-components/input/checkbox.mdx
deleted file mode 100644
index f3783f446..000000000
--- a/packages/twenty-docs/docs/ui-components/input/checkbox.mdx
+++ /dev/null
@@ -1,93 +0,0 @@
----
-title: Checkbox
-sidebar_position: 4
-sidebar_custom_props:
- icon: TbCheckbox
----
-
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import checkboxCode from '!!raw-loader!@site/src/ui/input/components/checkboxCode.js'
-
-Used when a user needs to select multiple values from several options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
checked
-
boolean
-
Indicates whether the checkbox is checked
-
-
-
-
-
indeterminate
-
boolean
-
Indicates whether the checkbox is in an indeterminate state (neither checked nor unchecked)
-
-
-
-
-
onChange
-
function
-
The callback function you want to trigger when the checkbox state changes
-
-
-
-
-
onCheckedChange
-
function
-
The callback function you want to trigger when the `checked` state changes
-
-
-
-
-
variant
-
string
-
The visual style variant of the box. Options include: `primary`, `secondary`, and `tertiary`
-
primary
-
-
-
-
size
-
string
-
The size of the checkbox. Has two options: `small` and `large`
-
small
-
-
-
-
shape
-
string
-
The shape of the checkbox. Has two options: `squared` and `rounded`
-
squared
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/color-scheme.mdx b/packages/twenty-docs/docs/ui-components/input/color-scheme.mdx
deleted file mode 100644
index 5f7e424ae..000000000
--- a/packages/twenty-docs/docs/ui-components/input/color-scheme.mdx
+++ /dev/null
@@ -1,113 +0,0 @@
----
-title: Color Scheme
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbColorFilter
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import colorSchemeCardCode from '!!raw-loader!@site/src/ui/input/color-scheme/colorSchemeCardCode.js'
-import colorSchemePickerCode from '!!raw-loader!@site/src/ui/input/color-scheme/colorSchemePickerCode.js'
-
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-
-## Color Scheme Card
-
-Represents different color schemes and is specially tailored for light and dark themes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
variant
-
string
-
The color scheme variant. Options include `Dark`, `Light`, and `System`
-
light
-
-
-
-
selected
-
boolean
-
If `true`, displays a checkmark to indicate the selected color scheme
-
-
-
-
-
additional props
-
`React.ComponentPropsWithoutRef<'div'>`
-
Standard HTML `div` element props
-
-
-
-
-
-
-
-
-
-
-## Color Scheme Picker
-
-Allows users to choose between different color schemes.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
value
-
`Color Scheme`
-
The currently selected color scheme
-
-
-
-
onChange
-
function
-
The callback function you want to trigger when a user selects a color scheme
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/icon-picker.mdx b/packages/twenty-docs/docs/ui-components/input/icon-picker.mdx
deleted file mode 100644
index 379a83dee..000000000
--- a/packages/twenty-docs/docs/ui-components/input/icon-picker.mdx
+++ /dev/null
@@ -1,92 +0,0 @@
----
-title: Icon Picker
-sidebar_position: 5
-sidebar_custom_props:
- icon: TbColorPicker
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import iconPickerCode from '!!raw-loader!@site/src/ui/input/components/iconPickerCode.js'
-
-A dropdown-based icon picker that allows users to select an icon from a list.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
disabled
-
boolean
-
Disables the icon picker if set to `true`
-
-
-
-
-
onChange
-
function
-
The callback function triggered when the user selects an icon. It receives an object with `iconKey` and `Icon` properties
-
-
-
-
-
selectedIconKey
-
string
-
The key of the initially selected icon
-
-
-
-
-
onClickOutside
-
function
-
Callback function triggered when the user clicks outside the dropdown
-
-
-
-
-
onClose
-
function
-
Callback function triggered when the dropdown is closed
-
-
-
-
-
onOpen
-
function
-
Callback function triggered when the dropdown is opened
-
-
-
-
-
variant
-
string
-
The visual style variant of the clickable icon. Options include: `primary`, `secondary`, and `tertiary`
-
secondary
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/image-input.mdx b/packages/twenty-docs/docs/ui-components/input/image-input.mdx
deleted file mode 100644
index 8c2a93a00..000000000
--- a/packages/twenty-docs/docs/ui-components/input/image-input.mdx
+++ /dev/null
@@ -1,92 +0,0 @@
----
-title: Image Input
-sidebar_position: 6
-sidebar_custom_props:
- icon: TbUpload
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import imageInputCode from '!!raw-loader!@site/src/ui/input/components/imageInputCode.js'
-
-Allows users to upload and remove an image.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
picture
-
string
-
The image source URL
-
-
-
-
-
onUpload
-
function
-
The function called when a user uploads a new image. It receives the `File` object as a parameter
-
-
-
-
-
onRemove
-
function
-
The function called when the user clicks on the remove button
-
-
-
-
-
onAbort
-
function
-
The function called when a user clicks on the abort button during image upload
-
-
-
-
-
isUploading
-
boolean
-
Indicates whether an image is currently being uploaded
-
`false`
-
-
-
-
errorMessage
-
string
-
An optional error message to display below the image input
-
-
-
-
-
disabled
-
boolean
-
If `true`, the entire input is disabled, and the buttons are not clickable
-
`false`
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/radio.mdx b/packages/twenty-docs/docs/ui-components/input/radio.mdx
deleted file mode 100644
index 9cca67f83..000000000
--- a/packages/twenty-docs/docs/ui-components/input/radio.mdx
+++ /dev/null
@@ -1,164 +0,0 @@
----
-title: Radio
-sidebar_position: 7
-sidebar_custom_props:
- icon: TbCircleDot
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import radioCode from '!!raw-loader!@site/src/ui/input/components/radioCode.js'
-import radioGroupCode from '!!raw-loader!@site/src/ui/input/components/radioGroupCode.js'
-
-Used when users may only choose one option from a series of options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
style
-
`React.CSS` properties
-
Additional inline styles for the component
-
-
-
-
-
className
-
string
-
Optional CSS class for additional styling
-
-
-
-
-
checked
-
boolean
-
Indicates whether the radio button is checked
-
-
-
-
-
value
-
string
-
The label or text associated with the radio button
-
-
-
-
-
onChange
-
function
-
The function called when the selected radio button is changed
-
-
-
-
-
onCheckedChange
-
function
-
The function called when the `checked` state of the radio button changes
-
-
-
-
-
size
-
string
-
The size of the radio button. Options include: `large` and `small`
-
small
-
-
-
-
disabled
-
boolean
-
If `true`, the radio button is disabled and not clickable
-
false
-
-
-
-
labelPosition
-
string
-
The position of the label text relative to the radio button. Has two options: `left` and `right`
-
right
-
-
-
-
-
-
-
-
-
-## Radio Group
-
-Groups together related radio buttons.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
value
-
string
-
The value of the currently selected radio button
-
-
-
-
onChange
-
function
-
The callback function triggered when the radio button is changed
-
-
-
-
onValueChange
-
function
-
The callback function triggered when the selected value in the group changes.
-
-
-
-
children
-
`React.ReactNode`
-
Allows you to pass React components (such as Radio) as children to the Radio Group
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/select.mdx b/packages/twenty-docs/docs/ui-components/input/select.mdx
deleted file mode 100644
index ef83cbb81..000000000
--- a/packages/twenty-docs/docs/ui-components/input/select.mdx
+++ /dev/null
@@ -1,85 +0,0 @@
----
-title: Select
-sidebar_position: 8
-sidebar_custom_props:
- icon: TbSelect
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import selectCode from '!!raw-loader!@site/src/ui/input/components/selectCode.js'
-
-Allows users to pick a value from a list of predefined options.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
-
className
-
string
-
Optional CSS class for additional styling
-
-
-
-
disabled
-
boolean
-
When set to `true`, disables user interaction with the component
-
-
-
-
dropdownScopeId
-
string
-
Required prop that uniquely identifies the dropdown scope
-
-
-
-
label
-
string
-
The label to describe the purpose of the `Select` component
-
-
-
-
onChange
-
function
-
The function called when the selected values change
-
-
-
-
options
-
array
-
Represents the options available for the `Selected` component. It's an array of objects where each object has a `value` (the unique identifier), `label` (the unique identifier), and an optional `Icon`
-
-
-
-
value
-
string
-
Represents the currently selected value. It should match one of the `value` properties in the `options` array
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/text.mdx b/packages/twenty-docs/docs/ui-components/input/text.mdx
deleted file mode 100644
index 91812f4b1..000000000
--- a/packages/twenty-docs/docs/ui-components/input/text.mdx
+++ /dev/null
@@ -1,322 +0,0 @@
----
-title: Text
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbTextSize
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import textInputCode from '!!raw-loader!@site/src/ui/input/components/textInputCode.js'
-import autosizeTextInputCode from '!!raw-loader!@site/src/ui/input/components/autosizeTextInputCode.js'
-import entityTitleDoubleTextInputCode from '!!raw-loader!@site/src/ui/input/components/entityTitleDoubleTextInputCode.js'
-import textAreaCode from '!!raw-loader!@site/src/ui/input/components/textAreaCode.js'
-
-## Text Input
-
-Allows users to enter and edit text.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
label
-
string
-
Represents the label for the input
-
-
-
-
-
onChange
-
function
-
The function called when the input value changes
-
-
-
-
-
fullWidth
-
boolean
-
Indicates whether the input should take up 100% of the width
-
-
-
-
-
disableHotkeys
-
boolean
-
Indicates whether hotkeys are enabled for the input
-
`false`
-
-
-
-
error
-
string
-
Represents the error message to be displayed. When provided, it also adds an icon error on the right side of the input
-
-
-
-
-
onKeyDown
-
function
-
Called when a key is pressed down while the input field is focused. Receives a `React.KeyboardEvent` as an argument
-
-
-
-
-
RightIcon
-
IconComponent
-
An optional icon component displayed on the right side of the input
-
-
-
-
-
-
-The component also accepts other HTML input element props.
-
-
-
-
-
-
-## Autosize Text Input
-
-Text input component that automatically adjusts its height based on the content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
onValidate
-
function
-
The callback function you want to trigger when the user validates the input
-
-
-
-
-
minRows
-
number
-
The minimum number of rows for the text area
-
1
-
-
-
-
placeholder
-
string
-
The placeholder text you want to display when the text area is empty
-
-
-
-
-
onFocus
-
function
-
The callback function you want to trigger when the text area gains focus
-
-
-
-
-
variant
-
string
-
The variant of the input. Options include: `default`, `icon`, and `button`
-
default
-
-
-
-
buttonTitle
-
string
-
The title for the button (only applicable for the button variant)
-
-
-
-
-
value
-
string
-
The initial value for the text area
-
Empty string
-
-
-
-
-
-
-
-
-
-
-## Entity Title Double Text Input
-
-Displays a pair of text inputs side by side, allowing the user to edit two related values simultaneously.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
firstValue
-
string
-
The value for the first text input
-
-
-
-
secondValue
-
string
-
The value for the second text input
-
-
-
-
firstValuePlaceholder
-
string
-
Placeholder text for the first text input, displayed when the input is empty
-
-
-
-
secondValuePlaceholder
-
string
-
Placeholder text for the second text input, displayed when the input is empty
-
-
-
-
onChange
-
function
-
The callback function you want to trigger when the text input changes
-
-
-
-
-
-
-
-
-## Text Area
-
-Allows you to create multi-line text inputs.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
disabled
-
boolean
-
Indicates whether the text area is disabled
-
-
-
-
-
minRows
-
number
-
Minimum number of visible rows for the text area.
-
1
-
-
-
-
onChange
-
function
-
Callback function triggered when the text area content changes
-
-
-
-
-
placeholder
-
string
-
Placeholder text displayed when the text area is empty
-
-
-
-
-
value
-
string
-
The current value of the text area
-
Empty string
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/input/toggle.mdx b/packages/twenty-docs/docs/ui-components/input/toggle.mdx
deleted file mode 100644
index 4d93dd35b..000000000
--- a/packages/twenty-docs/docs/ui-components/input/toggle.mdx
+++ /dev/null
@@ -1,71 +0,0 @@
----
-title: Toggle
-sidebar_position: 10
-sidebar_custom_props:
- icon: TbToggleRight
----
-
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import toggleCode from '!!raw-loader!@site/src/ui/input/components/toggleCode.js'
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
value
-
boolean
-
The current state of the toggle
-
`false`
-
-
-
-
onChange
-
function
-
Callback function triggered when the toggle state changes
-
-
-
-
-
color
-
string
-
Color of the toggle when it's in the "on" state. If not provided, it uses the theme's blue color
-
-
-
-
-
toggleSize
-
string
-
Size of the toggle, affecting both height and weight. Has two options: `small` and `medium`
-
medium
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/navigation/_category_.json b/packages/twenty-docs/docs/ui-components/navigation/_category_.json
deleted file mode 100644
index f02c4767a..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/_category_.json
+++ /dev/null
@@ -1,9 +0,0 @@
-{
- "label": "Navigation",
- "position": 4,
- "collapsible": true,
- "collapsed": false,
- "customProps": {
- "icon": "TbNavigation"
- }
-}
diff --git a/packages/twenty-docs/docs/ui-components/navigation/bread-crumb.mdx b/packages/twenty-docs/docs/ui-components/navigation/bread-crumb.mdx
deleted file mode 100644
index 14265e356..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/bread-crumb.mdx
+++ /dev/null
@@ -1,53 +0,0 @@
----
-title: Breadcrumb
-sidebar_position: 1
-sidebar_custom_props:
- icon: TbSquareChevronsRight
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import breadcrumbCode from '!!raw-loader!@site/src/ui/navigation/breadcrumbCode.js'
-
-Renders a breadcrumb navigation bar.
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
className
-
string
-
Optional class name for additional styling
-
-
-
-
links
-
array
-
An array of objects, each representing a breadcrumb link. Each object has a `children` property (the text content of the link) and an optional `href` property (the URL to navigate to when the link is clicked)
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/navigation/link.mdx b/packages/twenty-docs/docs/ui-components/navigation/link.mdx
deleted file mode 100644
index 08260e436..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/link.mdx
+++ /dev/null
@@ -1,237 +0,0 @@
----
-title: Links
-sidebar_position: 2
-sidebar_custom_props:
- icon: TbLink
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import contactLinkCode from '!!raw-loader!@site/src/ui/navigation/link/contactLinkCode.js'
-import rawLinkCode from '!!raw-loader!@site/src/ui/navigation/link/rawLinkCode.js'
-import roundedLinkCode from '!!raw-loader!@site/src/ui/navigation/link/roundedLinkCode.js'
-import socialLinkCode from '!!raw-loader!@site/src/ui/navigation/link/socialLinkCode.js'
-
-
-## Contact Link
-
-A stylized link component for displaying contact information.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
href
-
string
-
The target URL or path for the link
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the link is clicked
-
-
-
-
children
-
`React.ReactNode`
-
The content to be displayed inside the link
-
-
-
-
-
-
-
-
-
-## Raw Link
-
-A stylized link component for displaying links.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
href
-
string
-
The target URL or path for the link
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the link is clicked
-
-
-
-
children
-
`React.ReactNode`
-
The content to be displayed inside the link
-
-
-
-
-
-
-
-
-
-## Rounded Link
-
-A rounded-styled link with a Chip component for links.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
href
-
string
-
The target URL or path for the link
-
-
-
-
children
-
`React.ReactNode`
-
The content to be displayed inside the link
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the link is clicked
-
-
-
-
-
-
-
-
-
-## Social Link
-
-Stylized social links, with support for various social link types, such as URLs, LinkedIn, and X (or Twitter).
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
href
-
string
-
The target URL or path for the link
-
-
-
-
children
-
`React.ReactNode`
-
The content to be displayed inside the link
-
-
-
-
type
-
string
-
The type of social links. Options include: `url`, `LinkedIn`, and `Twitter`
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the link is clicked
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/navigation/menu-item.mdx b/packages/twenty-docs/docs/ui-components/navigation/menu-item.mdx
deleted file mode 100644
index 4a1de7906..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/menu-item.mdx
+++ /dev/null
@@ -1,768 +0,0 @@
----
-title: Menu Item
-sidebar_position: 3
-sidebar_custom_props:
- icon: TbMenu
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import menuItemCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemCode.js'
-import menuItemCommandCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemCommandCode.js'
-import menuItemDraggableCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemDraggableCode.js'
-import menuItemMultiSelectAvatarCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemMultiSelectAvatarCode.js'
-import menuItemMultiSelectCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemMultiSelectCode.js'
-import menuItemNavigateCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemNavigateCode.js'
-import menuItemSelectAvatarCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemSelectAvatarCode.js'
-import menuItemSelectCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemSelectCode.js'
-import menuItemSelectColorCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemSelectColorCode.js'
-import menuItemToggleCode from '!!raw-loader!@site/src/ui/navigation/menu-item/menuItemToggleCode.js'
-
-A versatile menu item designed to be used in a menu or navigation list.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
-
accent
-
string
-
Specifies the accent color of the menu item. Options include: `default`, `danger`, and `placeholder`
-
default
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
-
iconButtons
-
array
-
An array of objects representing additional icon buttons associated with the menu item
-
-
-
-
-
isTooltipOpen
-
boolean
-
Controls the visibility of the tooltip associated with the menu item
-
-
-
-
-
testId
-
string
-
The data-testid attribute for testing purposes
-
-
-
-
-
onClick
-
function
-
Callback function triggered when the menu item is clicked
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-
-## Variants
-
-The different variants of the menu item component include the following:
-
-### Command
-
-A command-style menu item within a menu to indicate keyboard shortcuts.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
firstHotKey
-
string
-
The first keyboard shortcut associated with the command
-
-
-
-
secondHotKey
-
string
-
The second keyboard shortcut associated with the command
-
-
-
-
isSelected
-
boolean
-
Indicates whether the menu item is selected or highlighted
-
-
-
-
onClick
-
function
-
Callback function triggered when the menu item is clicked
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Draggable
-
-A draggable menu item component designed to be used in a menu or list where items can be dragged, and additional actions can be performed through icon buttons.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
-
accent
-
string
-
The accent color of the menu item. It can either be `default`, `placeholder`, and `danger`
-
default
-
-
-
-
iconButtons
-
array
-
An array of objects representing additional icon buttons associated with the menu item
-
-
-
-
-
isTooltipOpen
-
boolean
-
Controls the visibility of the tooltip associated with the menu item
-
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the link is clicked
-
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
-
isDragDisabled
-
boolean
-
Indicates whether dragging is disabled
-
`false`
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-
-### Multi Select
-
-Provides a way to implement multi-select functionality with an associated checkbox.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
selected
-
boolean
-
Indicates whether the menu item is selected (checked)
-
-
-
-
onSelectChange
-
function
-
Callback function triggered when the checkbox state changes
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Multi Select Avatar
-
-A multi-select menu item with an avatar, a checkbox for selection, and textual content.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
avatar
-
`ReactNode`
-
The avatar or icon to be displayed on the left side of the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
selected
-
boolean
-
Indicates whether the menu item is selected (checked)
-
-
-
-
onSelectChange
-
function
-
Callback function triggered when the checkbox state changes
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Navigate
-
-A menu item featuring an optional left icon, textual content, and a right-chevron icon.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the menu item is clicked
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Select
-
-A selectable menu item, featuring optional left content (icon and text) and an indicator (check icon) for the selected state.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
selected
-
boolean
-
Indicates whether the menu item is selected (checked)
-
-
-
-
disabled
-
boolean
-
Indicates whether the menu item is disabled
-
-
-
-
hovered
-
boolean
-
Indicates whether the menu item is currently being hovered over
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the menu item is clicked
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Select Avatar
-
-A selectable menu item with an avatar, featuring optional left content (avatar and text) and an indicator (check icon) for the selected state.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
avatar
-
`ReactNode`
-
The avatar or icon to be displayed on the left side of the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
selected
-
boolean
-
Indicates whether the menu item is selected (checked)
-
-
-
-
disabled
-
boolean
-
Indicates whether the menu item is disabled
-
-
-
-
hovered
-
boolean
-
Indicates whether the menu item is currently being hovered over
-
-
-
-
testId
-
string
-
The data-testid attribute for testing purposes
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the menu item is clicked
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-### Select Color
-
-A selectable menu item with a color sample for scenarios where you want users to choose a color from a menu.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
Default
-
-
-
-
-
-
color
-
string
-
The theme color to be displayed as a sample in the menu item. Options include: `green`, `turquoise`, `sky`, `blue`, `purple`, `pink`, `red`, `orange`, `yellow`, and `gray`
-
-
-
-
-
selected
-
boolean
-
Indicates whether the menu item is selected (checked)
-
-
-
-
-
disabled
-
boolean
-
Indicates whether the menu item is disabled
-
-
-
-
-
hovered
-
boolean
-
Indicates whether the menu item is currently being hovered over
-
-
-
-
-
variant
-
string
-
The variant of the color sample. It can either be `default` or `pipeline`
-
default
-
-
-
-
onClick
-
function
-
Callback function to be triggered when the menu item is clicked
-
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
-
-
-### Toggle
-
-A menu item with an associated toggle switch to allow users to enable or disable a specific feature
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
LeftIcon
-
IconComponent
-
An optional left icon displayed before the text in the menu item
-
-
-
-
text
-
string
-
The text content of the menu item
-
-
-
-
toggled
-
boolean
-
Indicates whether the toggle switch is in the "on" or "off" state
-
-
-
-
onToggleChange
-
function
-
Callback function triggered when the toggle switch state changes
-
-
-
-
toggleSize
-
string
-
The size of the toggle switch. It can be either 'small' or 'medium'
-
-
-
-
className
-
string
-
Optional name for additional styling
-
-
-
-
-
-
-
-
diff --git a/packages/twenty-docs/docs/ui-components/navigation/navigation-bar.mdx b/packages/twenty-docs/docs/ui-components/navigation/navigation-bar.mdx
deleted file mode 100644
index 2e2e98d98..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/navigation-bar.mdx
+++ /dev/null
@@ -1,53 +0,0 @@
----
-title: Navigation Bar
-sidebar_position: 4
-sidebar_custom_props:
- icon: TbRectangle
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import navBarCode from '!!raw-loader!@site/src/ui/navigation/navBarCode.js'
-
-Renders a navigation bar that contains multiple `NavigationBarItem` components.
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
activeItemName
-
string
-
The name of the currently active navigation item
-
-
-
-
items
-
array
-
An array of objects representing each navigation item. Each object contains the `name` of the item, the `Icon` component to display, and an `onClick` function to be called when the item is clicked
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/packages/twenty-docs/docs/ui-components/navigation/step-bar.mdx b/packages/twenty-docs/docs/ui-components/navigation/step-bar.mdx
deleted file mode 100644
index 9af8838e2..000000000
--- a/packages/twenty-docs/docs/ui-components/navigation/step-bar.mdx
+++ /dev/null
@@ -1,47 +0,0 @@
----
-title: Step Bar
-sidebar_position: 5
-sidebar_custom_props:
- icon: TbCircleCheckFilled
----
-
-import Tabs from '@theme/Tabs';
-import TabItem from '@theme/TabItem';
-import { SandpackEditor} from '@site/src/ui/SandpackEditor'
-import stepBarCode from '!!raw-loader!@site/src/ui/navigation/stepBarCode.js'
-
-Displays progress through a sequence of numbered steps by highlighting the active step. It renders a container with steps, each represented by the `Step` component.
-
-
-
-
-
-
-
-
-
-
-
-
-
Props
-
Type
-
Description
-
-
-
-
-
-
activeStep
-
number
-
The index of the currently active step. This determines which step should be visually highlighted
- A token is required as APIs are dynamically generated for each
- workspace based on their unique metadata. Generate your token
- under{' '}
-
- Settings > Developers
-
-
Discord · 
Figma
-
-
-