diff --git a/packages/twenty-website/public/images/user-guide/all-opportunities-dark.png b/packages/twenty-website/public/images/user-guide/all-opportunities-dark.png deleted file mode 100644 index 4c4a19b15..000000000 Binary files a/packages/twenty-website/public/images/user-guide/all-opportunities-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/all-opportunities-light.png b/packages/twenty-website/public/images/user-guide/all-opportunities-light.png deleted file mode 100644 index 49ec3348b..000000000 Binary files a/packages/twenty-website/public/images/user-guide/all-opportunities-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/attach-files-to-records-dark.png b/packages/twenty-website/public/images/user-guide/attach-files-to-records-dark.png deleted file mode 100644 index 14c95fd14..000000000 Binary files a/packages/twenty-website/public/images/user-guide/attach-files-to-records-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/attach-files-to-records-light.png b/packages/twenty-website/public/images/user-guide/attach-files-to-records-light.png deleted file mode 100644 index abee0009d..000000000 Binary files a/packages/twenty-website/public/images/user-guide/attach-files-to-records-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/compact-opportunities-view-dark.png b/packages/twenty-website/public/images/user-guide/compact-opportunities-view-dark.png deleted file mode 100644 index d4e7c8290..000000000 Binary files a/packages/twenty-website/public/images/user-guide/compact-opportunities-view-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/compact-opportunities-view-light.png b/packages/twenty-website/public/images/user-guide/compact-opportunities-view-light.png deleted file mode 100644 index 8c136754d..000000000 Binary files a/packages/twenty-website/public/images/user-guide/compact-opportunities-view-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/connect-zapier.png b/packages/twenty-website/public/images/user-guide/connect-zapier.png deleted file mode 100644 index b449b882d..000000000 Binary files a/packages/twenty-website/public/images/user-guide/connect-zapier.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/create-custom-object.gif b/packages/twenty-website/public/images/user-guide/create-custom-object.gif deleted file mode 100644 index e5d5d9ad6..000000000 Binary files a/packages/twenty-website/public/images/user-guide/create-custom-object.gif and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/create-new-note-dark.png b/packages/twenty-website/public/images/user-guide/create-new-note-dark.png deleted file mode 100644 index 691f5e252..000000000 Binary files a/packages/twenty-website/public/images/user-guide/create-new-note-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/create-new-note-light.png b/packages/twenty-website/public/images/user-guide/create-new-note-light.png deleted file mode 100644 index e4eba65eb..000000000 Binary files a/packages/twenty-website/public/images/user-guide/create-new-note-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/create-new-task-dark.png b/packages/twenty-website/public/images/user-guide/create-new-task-dark.png deleted file mode 100644 index 3cced54db..000000000 Binary files a/packages/twenty-website/public/images/user-guide/create-new-task-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/create-new-task-light.png b/packages/twenty-website/public/images/user-guide/create-new-task-light.png deleted file mode 100644 index 25bbf2ebd..000000000 Binary files a/packages/twenty-website/public/images/user-guide/create-new-task-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/display-fields-dark.png b/packages/twenty-website/public/images/user-guide/display-fields-dark.png deleted file mode 100644 index b1ea57b63..000000000 Binary files a/packages/twenty-website/public/images/user-guide/display-fields-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/display-fields-light.png b/packages/twenty-website/public/images/user-guide/display-fields-light.png deleted file mode 100644 index 6d688d652..000000000 Binary files a/packages/twenty-website/public/images/user-guide/display-fields-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/filter-opportunities-dark.png b/packages/twenty-website/public/images/user-guide/filter-opportunities-dark.png deleted file mode 100644 index 5708d3a80..000000000 Binary files a/packages/twenty-website/public/images/user-guide/filter-opportunities-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/filter-opportunities-light.png b/packages/twenty-website/public/images/user-guide/filter-opportunities-light.png deleted file mode 100644 index 32ed1a445..000000000 Binary files a/packages/twenty-website/public/images/user-guide/filter-opportunities-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/manage-custom-object.png b/packages/twenty-website/public/images/user-guide/manage-custom-object.png deleted file mode 100644 index 142ba9cfb..000000000 Binary files a/packages/twenty-website/public/images/user-guide/manage-custom-object.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/placeholder-header.png b/packages/twenty-website/public/images/user-guide/placeholder-header.png index 4d5bc46f1..368d660e8 100644 Binary files a/packages/twenty-website/public/images/user-guide/placeholder-header.png and b/packages/twenty-website/public/images/user-guide/placeholder-header.png differ diff --git a/packages/twenty-website/public/images/user-guide/view-all-objects-dark.png b/packages/twenty-website/public/images/user-guide/view-all-objects-dark.png deleted file mode 100644 index 273602d7a..000000000 Binary files a/packages/twenty-website/public/images/user-guide/view-all-objects-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/view-all-objects-light.png b/packages/twenty-website/public/images/user-guide/view-all-objects-light.png deleted file mode 100644 index 9e596ec54..000000000 Binary files a/packages/twenty-website/public/images/user-guide/view-all-objects-light.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/view-favorite-records-dark.png b/packages/twenty-website/public/images/user-guide/view-favorite-records-dark.png deleted file mode 100644 index 058765b24..000000000 Binary files a/packages/twenty-website/public/images/user-guide/view-favorite-records-dark.png and /dev/null differ diff --git a/packages/twenty-website/public/images/user-guide/view-favorite-records-light.png b/packages/twenty-website/public/images/user-guide/view-favorite-records-light.png deleted file mode 100644 index 8bba08830..000000000 Binary files a/packages/twenty-website/public/images/user-guide/view-favorite-records-light.png and /dev/null differ diff --git a/packages/twenty-website/src/content/user-guide/_category_.json b/packages/twenty-website/src/content/user-guide/_category_.json deleted file mode 100644 index 38e8529b6..000000000 --- a/packages/twenty-website/src/content/user-guide/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "label": "User Guide", - "position": 3 -} diff --git a/packages/twenty-website/src/content/user-guide/api-webhooks.mdx b/packages/twenty-website/src/content/user-guide/api-webhooks.mdx index 03aa15b1b..f4bd4052b 100644 --- a/packages/twenty-website/src/content/user-guide/api-webhooks.mdx +++ b/packages/twenty-website/src/content/user-guide/api-webhooks.mdx @@ -1,5 +1,5 @@ --- -title: API Keys +title: API and Wehooks info: Learn how to manage API keys and Webhooks in Twenty. icon: IconApi image: /images/user-guide/placeholder-header.png @@ -24,6 +24,25 @@ For example, you can use them to retrieve details of a specific `Person` or `Com Since your API key gives access to sensitive information, you shouldn't share it with services you don't fully trust. If leaked, someone can use it maliciously. If your API key's security is compromised, immediately disable it and generate a new one. +
+ +
+ + ## Regenerating an API key @@ -41,6 +60,25 @@ For instance, a webhook can alert your system in real-time when someone creates 2. Enter your URL. 3. Click Save. +
+ +
+ + ## Deleting Webhooks 1. In Developers, find your webhook. diff --git a/packages/twenty-website/src/content/user-guide/basics/_category_.json b/packages/twenty-website/src/content/user-guide/basics/_category_.json deleted file mode 100644 index cd758c340..000000000 --- a/packages/twenty-website/src/content/user-guide/basics/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Basics", - "position": 1 -} diff --git a/packages/twenty-website/src/content/user-guide/basics/custom-objects.mdx b/packages/twenty-website/src/content/user-guide/basics/custom-objects.mdx deleted file mode 100644 index 8e1741211..000000000 --- a/packages/twenty-website/src/content/user-guide/basics/custom-objects.mdx +++ /dev/null @@ -1,41 +0,0 @@ ---- -title: Custom Objects -position: 1 -icon: IconAugmentedReality ---- - - -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. All workspaces come with three standard objects by default: People, Companies, and Opportunities. Standard objects have standard fields that are also available for all Twenty users, like Account Owner and URL. - -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. For example, if you're Airbnb, you may want to create a custom object for Listings or Reservations. - -## Creating a new custom object - -To create a new custom object: - -1. Go to Settings in the sidebar on the left. -2. Under Workspace, go to Data model. Here you'll be able to see an overview of all your existing Standard and Custom objects (both active and disabled). -
- - - - -
- -3. Click on `+ New object` at the top, then choose Custom as the object type. Enter the name (both singular and plural), choose an icon, and add a description for your custom object and hit Save (at the top right). Using Listing as an example of custom object, the singular would be "listing" and the plural would be "listings" along with a description like "Listings that hosts created to showcase their property." - -
- -
- Create custom object -
- -
- -4. Once you create your custom object, you'll be able to manage it. You can edit the name, icon and description, view the different fields, and add more fields. - -
- Create custom object -
diff --git a/packages/twenty-website/src/content/user-guide/basics/notes.mdx b/packages/twenty-website/src/content/user-guide/basics/notes.mdx deleted file mode 100644 index cfcc26c98..000000000 --- a/packages/twenty-website/src/content/user-guide/basics/notes.mdx +++ /dev/null @@ -1,28 +0,0 @@ ---- -title: Notes -position: 1 -icon: IconNote ---- - - -Easily create a note to keep track of important information. - -## Create Notes - -To attach a note to the record, go to the Notes tab of a record page and click on `+ New Note`. You can also format, comment, and upload images to your notes. - - - -## Format Notes - -You can format your notes right from the editor. Use markdown syntax, press the `/` key or click on the `+` icon on the editor to see the different block options, such as headings, tables, and lists. You can also attach images to your note. - -Highlight the text to see more formatting options like bold, italics, and alignment options. - -You can also change the background color and text color of each block to highlight important things in your note. To do so, hover over the block you want to format and click on the `⋮⋮` icon besides the `+` icon. Click on Colors to open up all color options for both the text and the background. - -## Delete Notes - -To delete a note, open it and click on the trashcan icon on the upper right of the screen. This will permanently delete your note. - - diff --git a/packages/twenty-website/src/content/user-guide/basics/opportunities.mdx b/packages/twenty-website/src/content/user-guide/basics/opportunities.mdx deleted file mode 100644 index 4c4ecab2c..000000000 --- a/packages/twenty-website/src/content/user-guide/basics/opportunities.mdx +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: Opportunities -position: 1 -icon: IconTargetArrow ---- - -All opportunities are presented in a Kanban board, where each column represents the stage of your workflow and each card represents a record. For each card, you can list the amount, close date, probability, and the point of contact. You can also move each card between stages as it goes through your workflow. - - - -## Add and delete stages - -You can add as many stages as you'd like to perfectly capture your entire workflow. To add a new stage, click on Options on the top right, choose Stages, and then click on `+ Add stage`. Name your stage and hit `Enter` to create it. Click on the name of the stage and then on edit to change the stage's name and color. - -To delete a stage, click on the stage name or on the `⋮` icon that appears when you hover over a stage. Click on edit to open the menu and click on Delete at the bottom to permanently delete a stage. - -## Filter, update, and sort views - -It's easy to add filters and update your view to focus on only the most important things. To add a filter: -- Click Filter on the top right of the opportunities board and select the field you want to filter by (Amount, Close date, Company, Creation Date, Person, Pipeline Step, and Point of Contact). -- Select the filter's condition (is/is not, greater than/lesser than) and then choose the value of the field you want to filter by. -- You can either create a new view or update your current view with the filter in place. -- You can also add another filter by following the same steps or clicking on the `+ Add filter` button on top of the columns. -- To remove a filter condition, simply click on the X next to the attribute you used to filter the records. - - - -
- -You can also sort your records by Close date, Creation date, and Probability. To do so: -- Click on Sort on the top right. -- Choose Ascending or Descending, and then the field you want to sort the records by. -- You can then update your view or create a new one with the sort filter in place. - -## Display fields - -You can configure your kanban board to display some fields and hide others. By default, the Amount, Close date, Probability, and Point of Contact are all visible. To hide a field, click on Options on the top right, then on Fields to bring up the list of options. Hover over the field you want to hide to bring up the `-` button. Click on it to hide the field. - -You can also rearrange the order of fields by holding down the field name and dragging it to where you want it. - - - -
- -You can also hide all the fields, and get an overview of all the opportunities at a glance. To do so, click on Options on the top right and turn on the toggle in front of the Compact view option. - - \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/basics/tasks.mdx b/packages/twenty-website/src/content/user-guide/basics/tasks.mdx deleted file mode 100644 index 86c1c5135..000000000 --- a/packages/twenty-website/src/content/user-guide/basics/tasks.mdx +++ /dev/null @@ -1,16 +0,0 @@ ---- -title: Tasks -position: 1 -icon: IconChecklist ---- - - -You can find all the tasks from across your workspace in the Tasks window in your sidebar. You can also find a dedicated tab for Tasks on each record so you can add and edit tasks directly from each record. Alternatively, you can click on the `+` button on the top right of each record page and then click on Task to create a new task. - - - -## Tasks page - -Switch between upcoming and completed tasks to get an overview of what's pending and what's already been done. - -You can also see the tasks assigned to others by changing the assignee from the top right of the Tasks page, and edit each task to update the content, due dates, and assignee. You can also comment on each task. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/constants/UserGuideIndex.ts b/packages/twenty-website/src/content/user-guide/constants/UserGuideIndex.ts index 8698de50c..ae728d8d3 100644 --- a/packages/twenty-website/src/content/user-guide/constants/UserGuideIndex.ts +++ b/packages/twenty-website/src/content/user-guide/constants/UserGuideIndex.ts @@ -10,20 +10,26 @@ export type IndexHeading = { export const USER_GUIDE_INDEX = { 'Getting Started': [ { title: 'What is Twenty', url: 'what-is-twenty' }, - { title: 'Create a Workspace', url: 'create-a-workspace' }, - { title: 'Import your data', url: 'import-your-data' }, + { title: 'Create a Workspace', url: 'create-workspace' }, ], Objects: [ - { title: 'People', url: 'people' }, - { title: 'Companies', url: 'companies' }, - { title: 'Opportunities', url: 'opportunities' }, - { title: 'Custom Objects', url: 'custom-objects' }, - { title: 'Remote Objects', url: 'remote-objects' }, + { title: 'Objects', url: 'objects' }, + { title: 'Fields', url: 'fields' }, + { title: 'Views, Sort and Filter', url: 'views-sort-filter' }, + { title: 'Table Views', url: 'table-views' }, + { title: 'Kanban Views', url: 'kanban-views' }, + { title: 'Import/Export Data', url: 'import-export-data' }, ], Functions: [ - { title: 'Email', url: 'email' }, - { title: 'Calendar', url: 'calendar' }, + { title: 'Emails', url: 'emails' }, { title: 'Notes', url: 'notes' }, { title: 'Tasks', url: 'tasks' }, + { title: 'Integrations', url: 'integrations'}, + { title: 'API and Webhooks', url: 'api-webhooks'}, + ], + Other: [ + { title: 'Glossary', url: 'glossary'}, + { title: 'Tips', url: 'tips'}, + { title: 'Github', url: 'github'}, ], }; diff --git a/packages/twenty-website/src/content/user-guide/home.mdx b/packages/twenty-website/src/content/user-guide/home.mdx deleted file mode 100644 index 4f6d0865d..000000000 --- a/packages/twenty-website/src/content/user-guide/home.mdx +++ /dev/null @@ -1,54 +0,0 @@ ---- -title: Get started -position: 0 -icon: IconUsers -info: This is homepage ---- - -The purpose of this user guide is to help you learn how you can use Twenty to build the CRM you want. - -## Quick Search - -You'll see a search bar at the top of your sidebar. You can also bring up the command bar with the `cmd`/`ctrl` + `k` shortcut to navigate through your workspace, and find people, companies, notes, and more. - -The command bar also supports other shortcuts for navigation. - -## Create Pre-filtered Views - -Twenty allows you to add filters to see data that meets certain criteria and hides the rest. You can apply multiple filters at once. - -To create a filter in your workspace, click Filter at the top right and select the attribute you'd like to filter your records by. Create your filter and then save changes in a new view by clicking `+ Create view`. - -The filtered view is now available to your whole team. - -## Add Stages For Opportunities - -You can also add more stages to the opportunities board. - -On the Opportunities page, click on Options, Stages, then `+ Add Stage`. - -You can also edit the stage by clicking on the name. - -## Create Notes and Tasks For Each Record - -You can attach notes and tasks to each record. With Notes, you can keep a record of any observations, comments, and interactions, and keep track of all items that require action with Tasks. - -There are multiple ways to create notes and tasks. Learn more about [Notes](./basics/notes.mdx) and [Tasks](./basics/tasks.mdx). - -## Upload Files For Each Record - -You can also upload and attach files for each record. To do so, expand a record, and head over to the Files tab. You'll then see the `+ Add file` button. - - - -## Add Records To Favorites - -You can add records to your favorites for quick access. To do so, expand the record you want to add, and click on the heart icon on the top right. You'll now be able to see your favorite records in your sidebar right above your workspace. - - - -## Import data - -You can easily import People and Companies data into Twenty from other apps using a .csv, .xslx, or .xsl file. In the Companies or People page, click on Options and then on Import. - -Upload your file, match the columns, and validate the data to import it. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/import-export-data.mdx b/packages/twenty-website/src/content/user-guide/import-export-data.mdx index 57dcc2bec..218221adc 100644 --- a/packages/twenty-website/src/content/user-guide/import-export-data.mdx +++ b/packages/twenty-website/src/content/user-guide/import-export-data.mdx @@ -40,4 +40,4 @@ To export data from an object: title="Export data" > - + \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/integrations.mdx b/packages/twenty-website/src/content/user-guide/integrations.mdx index 8fb52a803..8d953fa59 100644 --- a/packages/twenty-website/src/content/user-guide/integrations.mdx +++ b/packages/twenty-website/src/content/user-guide/integrations.mdx @@ -40,4 +40,4 @@ Sync Twenty with 3000+ apps using [Zapier](https://zapier.com/apps/twenty/integr -You can now continue creating your automation! +You can now continue creating your automation! \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/integrations/_category_.json b/packages/twenty-website/src/content/user-guide/integrations/_category_.json deleted file mode 100644 index 4309ef82a..000000000 --- a/packages/twenty-website/src/content/user-guide/integrations/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Integrations", - "position": 2 -} diff --git a/packages/twenty-website/src/content/user-guide/integrations/connect-zapier.mdx b/packages/twenty-website/src/content/user-guide/integrations/connect-zapier.mdx deleted file mode 100644 index 139224fb4..000000000 --- a/packages/twenty-website/src/content/user-guide/integrations/connect-zapier.mdx +++ /dev/null @@ -1,25 +0,0 @@ ---- -title: Connect Zapier -position: 3 -icon: IconBrandZapier ---- - -
-Twenty integration is currently being registered in the public Zapier repository, you may not find it until the publishing process is complete. -
- - -Sync Twenty with 3000+ apps using [Zapier](https://zapier.com/), and automate your work. Here's how you can connect Twenty to Zapier: - -1. Go to Zapier and log in. -2. Click on `+ Create Zap` in the left sidebar. -3. Choose the application you want to set as the trigger. A trigger refers to an event that starts the automation. -4. Select Twenty as the action. An action is the event performed whenever an application triggers an automation. [Learn more about triggers and actions in Zapier.](https://zapier.com/how-it-works) -5. Once you choose the Twenty account that you want to use for your automation, you'll have to authorize it by adding an API key. You can learn [how to generate your API key here.](user-guide/integrations/generating-api-keys.mdx) -6. Enter your API key and click on 'Yes, Continue to Twenty.' - -
- Connect Twenty to Zapier -
- -You can now continue creating your automation! diff --git a/packages/twenty-website/src/content/user-guide/integrations/generating-api-keys.mdx b/packages/twenty-website/src/content/user-guide/integrations/generating-api-keys.mdx deleted file mode 100644 index efd5dd3bc..000000000 --- a/packages/twenty-website/src/content/user-guide/integrations/generating-api-keys.mdx +++ /dev/null @@ -1,23 +0,0 @@ ---- -title: API Keys -position: 2 -icon: IconApi ---- - -To generate an API key: - -1. Go to Settings in the sidebar on the left. -2. Under Workspace, go to Developers. Here, you'll see a list of active keys that you or your team have created. -3. To generate a new key, click on `+ Create key` on the top right. -4. Give your API key a name, an expiration date, and a logo. -5. Hit save to see your API key. -6. Since the key is only visible once, make sure you store it somewhere safe. - -
-Since your API key contains sensitive information, you shouldn't share it with services you don't fully trust. If leaked, someone can use it maliciously. If you think your API key is no longer secure, make sure you disable it and generate a new one. -
- - -## Regenerating API key - -To regenerate an API key, click on the key you want to regenerate. You'll then be able to see a button to regenerate the API key. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/notes.mdx b/packages/twenty-website/src/content/user-guide/notes.mdx index 3cedcec81..12d8ba957 100644 --- a/packages/twenty-website/src/content/user-guide/notes.mdx +++ b/packages/twenty-website/src/content/user-guide/notes.mdx @@ -64,4 +64,4 @@ To delete a note: 1. Open the note you wish to remove by clicking on it from within the `Record page`. 2. Click the trashcan icon located in the top right corner of the screen. -Please be aware that deleting a note is permanent and can't be undone. +Please be aware that deleting a note is permanent and can't be undone. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/objects.mdx b/packages/twenty-website/src/content/user-guide/objects.mdx index 7a592a7f4..1c34d1010 100644 --- a/packages/twenty-website/src/content/user-guide/objects.mdx +++ b/packages/twenty-website/src/content/user-guide/objects.mdx @@ -79,4 +79,4 @@ To create a new custom object: 4. Once you create your custom object, you'll be able to manage it. You can edit the name, icon and description, view the different fields, and add more fields. - + \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/others/_category_.json b/packages/twenty-website/src/content/user-guide/others/_category_.json deleted file mode 100644 index 66620be53..000000000 --- a/packages/twenty-website/src/content/user-guide/others/_category_.json +++ /dev/null @@ -1,4 +0,0 @@ -{ - "title": "Others", - "position": 3 -} diff --git a/packages/twenty-website/src/content/user-guide/others/glossary.mdx b/packages/twenty-website/src/content/user-guide/others/glossary.mdx deleted file mode 100644 index b6eac3456..000000000 --- a/packages/twenty-website/src/content/user-guide/others/glossary.mdx +++ /dev/null @@ -1,22 +0,0 @@ ---- -title: Glossary -position: 3 -icon: IconVocabulary ---- - -### Company & People -The CRM has two fundamental types of records: -- A `Company` represents a business or organization. -- `People` represent your company's current and prospective customers or clients. - -### Pipelines -A `Pipeline` is a way to track a business process. Pipelines are present within a *module* and have *stages*: -- A **module** contains the logic for a certain business process (for example: sales, recruiting). -- **Stages** map the steps in your process (for example: new, ongoing, won, lost). - -### Views -With views, you can customize how your records are displayed. You can have different filters and sort settings for each view. - -### Workspace -A `Workspace` typically represents a company using Twenty. It holds all the records and data that you and your team members add to Twenty. -It has a single domain name, which is typically the domain name your company uses for employee email addresses. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/others/tips.mdx b/packages/twenty-website/src/content/user-guide/others/tips.mdx deleted file mode 100644 index 17004ae06..000000000 --- a/packages/twenty-website/src/content/user-guide/others/tips.mdx +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: Tips -sidebar_position: 1 -icon: IconInfoCircle ---- - -## Update workspace name & logo - -Workspace admins can edit its name and logo in settings. - -- From the sidebar, go to Settings. -- Under Workspace, go to General. -- Edit the name and logo. Your changes will be saved automatically. - -## Enable dark mode - -Not a fan of light mode? Easily switch to dark mode with these steps: - -- From the sidebar, go to Settings. -- Under User, go to Appearance. -- Select Dark. Your changes will be saved automatically. - -## Account settings - -Configure your user account and set your preferences. - -- From the sidebar, go to Settings. -- Under User, go to Profile to edit your name and profile picture. You can upload PNGs, GIFs, and JPEGs. -- Manage your accounts and configure your email and calendar settings in Accounts. -- Your changes will be saved automatically. - -## Invite & manage members - -Admins can easily invite new members any time. - -- From the sidebar, go to Settings. -- Under Workspace, go to Members. -- Use the invite link to add more members to your workspace or simply delete existing ones. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/table-views.mdx b/packages/twenty-website/src/content/user-guide/table-views.mdx index cf10aca46..d3ac632ca 100644 --- a/packages/twenty-website/src/content/user-guide/table-views.mdx +++ b/packages/twenty-website/src/content/user-guide/table-views.mdx @@ -67,5 +67,4 @@ To create a custom field, click the **+** button at the right end of the table c -You can also do it by navigating to **Settings** > **Data Model** > **People**. Click on **Add Field**. Choose a field name and type. The new field will be available in the app. - +You can also do it by navigating to **Settings** > **Data Model** > **People**. Click on **Add Field**. Choose a field name and type. The new field will be available in the app. \ No newline at end of file diff --git a/packages/twenty-website/src/content/user-guide/tasks.mdx b/packages/twenty-website/src/content/user-guide/tasks.mdx index 113e856f3..11a52d456 100644 --- a/packages/twenty-website/src/content/user-guide/tasks.mdx +++ b/packages/twenty-website/src/content/user-guide/tasks.mdx @@ -14,6 +14,25 @@ Creating tasks in Twenty is seamless. You can either: - Use the search function by pressing `cmd/ctrl + k`, then select 'Create task' from the list of quick actions. - Go to a `Record page` and press `+`at the top right of the page, or go to the Task tab and press the `Add Task`button. +
+ +
+ + ## Adding Task Content Once you've created a task you can enrich it with rich content, such as Titles, Bullet points or even images. To do so, press "/" and enter the desired command. diff --git a/packages/twenty-website/src/content/user-guide/views.mdx b/packages/twenty-website/src/content/user-guide/views-sort-filter.mdx similarity index 99% rename from packages/twenty-website/src/content/user-guide/views.mdx rename to packages/twenty-website/src/content/user-guide/views-sort-filter.mdx index bad2464a1..200be0832 100644 --- a/packages/twenty-website/src/content/user-guide/views.mdx +++ b/packages/twenty-website/src/content/user-guide/views-sort-filter.mdx @@ -1,5 +1,5 @@ --- -title: Views +title: Views, Sort and Filter info: Find out how to create, manage and delete Object Views. icon: IconChecklist image: /images/user-guide/placeholder-header.png diff --git a/packages/twenty-website/src/content/user-guide/what-is-twenty.mdx b/packages/twenty-website/src/content/user-guide/what-is-twenty.mdx index 022dda1e5..43579c39d 100644 --- a/packages/twenty-website/src/content/user-guide/what-is-twenty.mdx +++ b/packages/twenty-website/src/content/user-guide/what-is-twenty.mdx @@ -1,57 +1,54 @@ --- title: What is Twenty -position: 0 icon: IconUsers -info: A brief on Twenty's commitment to reshaping CRM with Open Source -image: /images/user-guide/home/what-is-twenty.png +info: Discover Twenty, an open-source CRM, its features, benefits, system requirements, and how to get involved. +image: /images/user-guide/what-is-twenty/20.png --- -## What is Twenty +# Overview -The purpose of this user guide is to help you learn how you can use Twenty to build the CRM you want. +Twenty is the leading open-source CRM, crafted by hundreds of contributors to suit your unique business needs and processes. -## Quick Search +## Main Features -You'll see a search bar at the top of your sidebar. You can also bring up the command bar with the `cmd`/`ctrl` + `k` shortcut to navigate through your workspace, and find people, companies, notes, and more. +* **Contact Management:** Efficiently store and manage customer data. [Learn more](/user-guide/objects). +* **Custom Objects:** Create and customize objects to fit your business needs. [Details](/user-guide/objects). +* **Custom Fields:** Tailor data fields to capture and organize information specific to your operations. [Understand more](/user-guide/fields). +* **Kanban & Table Views:** Optimize your workflow with flexible [Table Views](/user-guide/table-views) and [Kanban Views](/user-guide/kanban-views). +* **Pipeline Visualization:** Get a clear view of your processes with customizable views. [Explore views](/user-guide/views-sort-and-filter). +* **Email Integration:** View the emails of a specific customer or company within your workspace. [Integrate now](/user-guide/emails). +* **Notes:** Create detailed notes for each record to share knowledge more effectively. [Add notes](/user-guide/notes). +* **Tasks:** Schedule tasks to track customer interactions. [See how](/user-guide/tasks). +* **API & Webhooks:** Connect to other apps and automate workflows with API and Webhooks. [Start integrating](/user-guide/integrations). -The command bar also supports other shortcuts for navigation. +## Benefits -## Create Pre-filtered Views +* Customized: Designed to fit your business needs. +* Community-driven: Built and maintained by a robust open-source community. +* Cost-effective: Open-source nature ensures competitive pricing. -Twenty allows you to add filters to see data that meets certain criteria and hides the rest. You can apply multiple filters at once. +## System Requirements -To create a filter in your workspace, click Filter at the top right and select the attribute you'd like to filter your records by. Create your filter and then save changes in a new view by clicking `+ Create view`. +* Modern web browser (e.g., Firefox, Chrome, Safari, Edge). +* Internet connection (Offline mode isn't yet supported). -The filtered view is now available to your whole team. +# Demo -## Add Stages For Opportunities +If you wish to try Twenty before to create your own account, go to demo.twenty.com and login with the following credentials: -You can also add more stages to the opportunities board. +``` +email: noah@demo.dev +password: Applecar2025 +``` -On the Opportunities page, click on Options, Stages, then `+ Add Stage`. +# Vision and mission -You can also edit the stage by clicking on the name. +Great companies often start with bets that seem like long shots. Only later do they appear as no-brainers. Searching the web through a text field, not a directory; letting strangers stay in your home; renting server space like a utility... -## Create Notes and Tasks For Each Record +Open-source is a marginal part of CRM today. Our bet is that open-source will ultimately dominate CRM market share. -You can attach notes and tasks to each record. With Notes, you can keep a record of any observations, comments, and interactions, and keep track of all items that require action with Tasks. +The open-source tide has been rising for some time already, following a simple rule: the closer to the developer stack, the higher the market share of open-source. -There are multiple ways to create notes and tasks. Learn more about [Notes](./basics/notes.mdx) and [Tasks](./basics/tasks.mdx). +# Join now -## Upload Files For Each Record - -You can also upload and attach files for each record. To do so, expand a record, and head over to the Files tab. You'll then see the `+ Add file` button. - - - -## Add Records To Favorites - -You can add records to your favorites for quick access. To do so, expand the record you want to add, and click on the heart icon on the top right. You'll now be able to see your favorite records in your sidebar right above your workspace. - - - -## Import data - -You can easily import People and Companies data into Twenty from other apps using a .csv, .xslx, or .xsl file. In the Companies or People page, click on Options and then on Import. - -Upload your file, match the columns, and validate the data to import it. \ No newline at end of file +Take Control, own your CRM today. [Register here](https://www.app.twenty.com) or [join as contributors on GitHub](https://github.com/twentyhq/twenty). \ No newline at end of file