change log, user guide, and readme updates for v1 launch (#12860)

### Summary 
- Minor updates to the user guide with clarification on product
functionality as per user confusion
- Updates to existing documentation about past features to reflect
current functionality (favorites, side panel controls, etc)
- Updated README with product hunt banner and new features for v1
release

---------

Co-authored-by: Vicky Wang <vw92@cornell.edu>
This commit is contained in:
Vicky Wang
2025-06-25 10:19:04 +02:00
committed by GitHub
parent 3595c650a2
commit 378e7cf6f1
28 changed files with 98 additions and 82 deletions

106
README.md
View File

@@ -1,5 +1,17 @@
<br />
<p align="center">
<a href="https://www.producthunt.com/products/twenty-crm">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/product-hunt-banner-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/product-hunt-banner-light.png" />
<img src="./packages/twenty-website/public/images/readme/product-hunt-banner-light.png" alt="Product Hung Banner" />
</picture>
</a>
</p>
<br />
<p align="center">
<a href="https://www.twenty.com">
<img src="./packages/twenty-website/public/images/core/logo.svg" width="100px" alt="Twenty logo" />
@@ -8,16 +20,16 @@
<h2 align="center" >The #1 Open-Source CRM </h2>
<p align="center"><a href="https://twenty.com">🌐 Website</a> · <a href="https://twenty.com/developers">📚 Documentation</a> · <a href="https://github.com/orgs/twentyhq/projects/1"><img src="./packages/twenty-website/public/images/readme/planner-icon.svg" width="12" height="12"/> Roadmap </a> · <a href="https://discord.gg/cx5n4Jzs57"><img src="./packages/twenty-website/public/images/readme/discord-icon.svg" width="12" height="12"/> Discord</a> · <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty"><img src="./packages/twenty-website/public/images/readme/figma-icon.png" width="12" height="12"/> Figma</a></p>
<p align="center"><a href="https://twenty.com">🌐 Website</a> · <a href="https://twenty.com/developers">📚 Documentation</a> · <a href="https://github.com/orgs/twentyhq/projects/1"><img src="./packages/twenty-website/public/images/readme/planner-icon.svg" width="12" height="12"/> Roadmap </a> · <a href="https://discord.gg/cx5n4Jzs57"><img src="./packages/twenty-website/public/images/readme/discord-icon.svg" width="12" height="12"/> Discord</a> · <a href="https://www.figma.com/file/xt8O9mFeLl46C5InWwoMrN/Twenty"><img src="./packages/twenty-website/public/images/readme/figma-icon.png" width="12" height="12"/> Figma</a></p>
<br />
<p align="center">
<a href="https://www.twenty.com">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/preview-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/preview-light.png" />
<img src="./packages/twenty-docs/static/img/preview-light.png" alt="Companies view" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/github-cover-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/github-cover-light.png" />
<img src="./packages/twenty-website/public/images/readme/github-cover-light.png" alt="Cover" />
</picture>
</a>
</p>
@@ -43,100 +55,68 @@ We built Twenty for three reasons:
<br />
# What You Can Do With Twenty
We're currently developing Twenty's beta version.
Please feel free to flag any specific needs you have by creating an issue.
Below are a few features we have implemented to date:
+ [Add, filter, sort, edit, and track customers](#add-filter-sort-edit-and-track-customers)
+ [Create one or several opportunities for each company](#create-one-or-several-opportunities-for-each-company)
+ [See rich notes tasks displayed in a timeline](#see-rich-notes-tasks-displayed-in-a-timeline)
+ [Create tasks on records](#create-tasks-on-records)
+ [Navigate quickly through the app using keyboard shortcuts and search](#navigate-quickly-through-the-app-using-keyboard-shortcuts-and-search)
+ [Personalize layouts with filters, sort, group by, kanban and table views](#personalize-layouts-with-filters-sort-group-by-kanban-and-table-views)
+ [Customize your objects and fields](#customize-your-objects-and-fields)
+ [Create and manage permissions with custom roles](#create-and-manage-permissions-with-custom-roles)
+ [Automate workflow with triggers and actions](#automate-workflow-with-triggers-and-actions)
+ [Emails, calendar events, files, and more](#emails-calendar-events-files-and-more)
## Add, filter, sort, edit, and track customers:
## Personalize layouts with filters, sort, group by, kanban and table views
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/index-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/index-light.png" />
<img src="./packages/twenty-docs/static/img/visualise-customer-light.png" alt="Companies view" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/views-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/views-light.png" />
<img src="./packages/twenty-website/public/images/readme/views-light.png" alt="Companies Kanban Views" />
</picture>
</p>
## Create one or several opportunities for each company:
## Customize your objects and fields
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/kanban-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/kanban-light.png" />
<img src="./packages/twenty-docs/static/img/follow-your-deals-light.png" alt="Opportunities view" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/data-model-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/data-model-light.png" />
<img src="./packages/twenty-website/public/images/readme/data-model-light.png" alt="Setting Custom Objects" />
</picture>
</p>
## Track deals effortlessly with the email integration:
## Create and manage permissions with custom roles
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/emails-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/emails-light.png" />
<img src="./packages/twenty-docs/static/img/emails-light.png" alt="Emails" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/permissions-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/permissions-light.png" />
<img src="./packages/twenty-website/public/images/readme/permissions-light.png" alt="Permissions" />
</picture>
</p>
## Tailor your data model to meet business needs:
## Automate workflow with triggers and actions
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/data-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/data-light.png" />
<img src="./packages/twenty-docs/static/img/data-light.png" alt="Data model" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/workflows-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/workflows-light.png" />
<img src="./packages/twenty-website/public/images/readme/workflows-light.png" alt="Workflows" />
</picture>
</p>
## See rich notes displayed in a timeline:
## Emails, calendar events, files, and more
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/notes-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/notes-light.png" />
<img src="./packages/twenty-docs/static/img/notes-light.png" alt="Rich notes" />
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/plus-other-features-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/refs/heads/DO-NOT-MERGE-UNTIL-LAUNCH-v1-updates/packages/twenty-website/public/images/readme/plus-other-features-light.png" />
<img src="./packages/twenty-website/public/images/readme/plus-other-features-light.png" alt="Other Features" />
</picture>
</p>
## Create tasks on records
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/tasks-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/tasks-light.png" />
<img src="./packages/twenty-docs/static/img/create-tasks-light.png" alt="Tasks" />
</picture>
</p>
## Navigate quickly through the app using keyboard shortcuts and search:
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/keyboard-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/keyboard-light.png" />
<img src="./packages/twenty-docs/static/img/keyboard-dark.png" alt="Keyboard shortcuts" />
</picture>
</p>
## Connect your CRM to all your tools through our APIs and Webhooks.
<p align="center">
<picture>
<source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/api-dark.png" />
<source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/twentyhq/twenty/v0.12.0/packages/twenty-docs/static/img/api-light.png" />
<img src="./packages/twenty-docs/static/img/api-light.png" alt="API" />
</picture>
</p>
<br />
# Stack
@@ -167,7 +147,3 @@ Below are a few features we have implemented to date:
- Join our [Discord](https://discord.gg/cx5n4Jzs57)
- Improve translations on [Crowdin](https://twenty.crowdin.com/twenty)
- [Contributions](https://github.com/twentyhq/twenty/contribute) are, of course, most welcome!

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.2 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.9 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 827 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 699 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.3 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.0 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 21 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.5 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.6 MiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 309 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 501 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 403 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 481 KiB

View File

Binary file not shown.

After

Width:  |  Height:  |  Size: 266 KiB

View File

@@ -2,6 +2,7 @@
release: 0.51.0
Date: March 27th 2025
---
# Revamp View Options Menu
You can now rename a view and change its type between kanban or table directly from the view options menu located to the right of the filter and sort buttons.

View File

@@ -2,14 +2,13 @@
release: 0.52.0
Date: April 25th 2025
---
# Add records to filtered views
Creating records on filtered views now applies the view filter to the newly created record. This feature is compatible with Text, Date\_Time, Date, Number, Select, Rating, Multi\_Select, Array, and Boolean fields.
![](/images/releases/0.52.0/0.52-filtered-views-records.png)
# Custom date formats
Choose how to display dates in any field using a universal Unicode date format that best suits your use case.

View File

@@ -0,0 +1,37 @@
---
release: 1.00.0
Date: June 25th 2025
---
# Permissions V2
Create and manage custom roles. Grant or revoke access for each object to Read/Create/Edit/Delete records. Give granular access to settings like the ability to manage users, data models or APIs.
![](/images/releases/1.00/1.00-permissions.png)
# Workflow Feature
Introducing workflows, a powerful way to let you automate actions with form triggers, conditions, HTTP requests, webhooks, and serverless functions!
![](/images/releases/1.00/1.00-workflow.png)
# Import Update
CSV import now supports 2,000+ rows, sub-fields such as labels and secondary phone numbers, and automatic field matching. Validations, layout, and upserts are improved for smoother, more accurate imports.
![](/images/releases/1.00/1.00-import-update.png)
# Sub-field Filtering
Sub-field filtering is now supported for currency, address, name, email, link, phone, and actor fields. For example, you can filter by the amount in a currency without needing the full field.
![](/images/releases/1.00/1.00-subfield-filtering.png)
# Performance Improvements
Weve cut key load and interaction times by over 3,000ms, which means pages now load 2x faster!
![](/images/releases/1.00/1.00-performance-improvement.png)

View File

@@ -12,8 +12,8 @@ Manage your record-linked notes efficiently using the powerful **Notes** feature
Creating notes in the system is intuitive and dynamic. You can either:
- Use the search function by pressing `cmd/ctrl + k`, then select 'Create note' from the list of quick actions.
- Go to a `Record page` and select `+` at the top right of the page, or go to the Notes tab and press the `New Note` button.
- Navigate to the notes view and create a new record.
- Go to a `Record page` and select the Notes tab and press the `New note` button.
<img src="/images/user-guide/notes/add-note.png"style={{width:'100%'}}/>
@@ -63,8 +63,10 @@ All edits and additions to the note are automatically saved.
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.
2. Select the note you want to delete within the notes tab.
3. Use the `Option` button on the lower right corner to prompt additional actions including delete.
4. Complete your deletion when prompted with the confirmation modal.
Please be aware that deleting a note is permanent and can't be undone.
Another way to delete a note is through the notes view like you would a regular record. Please be aware that deleting a note is permanent and can't be undone.
<ArticleEditContent></ArticleEditContent>

View File

@@ -8,7 +8,7 @@ sectionInfo: Discover how to use standard and custom objects in your workspace.
## Import data
You can import People and Companies data into Twenty from other apps using a .csv, .xlsx, or .xls file. In the <b>Companies</b> or <b>People</b> page, click on <b>Options</b> and then on <b>Import</b>.
You can import People and Companies data into Twenty from other apps using a .csv, .xlsx, or .xls file. In the <b>Companies</b> or <b>People</b> page, click on the `⋮` icon and then select `Import records`.
Upload your file, match the columns, check your data and import it.
@@ -20,8 +20,8 @@ To export data from an object:
1. Visit the object index.
2. Choose the view for data export.
3. Access the `Options` menu.
4. Click on `Export`.
3. Access the side panel through the `⋮` icon.
4. Click on `Export view`.
5. Select the save location for the CSV data. Note that exporting may take time with a large record count.
<div style={{padding:'71.24% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>

View File

@@ -76,8 +76,8 @@ You can also rearrange the order of fields by holding down the field name and dr
## Compact View
You can also hide all the fields, and get an overview of all the opportunities at a glance. To do so, click on <b>Options</b> on the top right and turn on the toggle in front of the <b>Compact view</b> option.
You can also hide all the fields, and get an overview of all the opportunities at a glance. To do so, click on <b>Options</b> on the top right and turn on the toggle for <b>Compact view</b> after selecting layout in kanban view.
<img src="/images/user-guide/kanban-views/compact-view.png"style={{width:'100%'}}/>
<img src="/images/user-guide/kanban-views/compact-view.png" style={{width:'100%'}}/>
<ArticleEditContent></ArticleEditContent>

View File

@@ -38,9 +38,9 @@ Enter the record name then press `Enter` to save. To edit a record name, click o
## Delete record
**Index View:** To delete a record, select the checkbox next to the record and click the delete button below.
**Index View:** To delete a record, select the checkbox next to the record and click the delete button on the top right corner.
**Record Page:** Tap the **3 dots menu** in the top right corner, then select delete.
**Record Page:** Tap the `⋮` icon in the top right corner, then select delete.
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>

View File

@@ -81,10 +81,11 @@ When you change the `Sorting` and `Filtering` of an existing view, a `Save as ne
To Edit or Delete a view:
1. Open the View Switcher
2. Hover the View you wish to edit
3. Click the `Pen Icon Button` that appears on the right
3. Click on the three dots that appear upon hover to edit and delete views
You will then be able to modify the view. To delete it, press the `Delete` button that just appeared.
Upon clicking on edit, you can change the icon and the name of the view or delete the view completely
Please note:
<div style={{padding:'69.01% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
<iframe
@@ -168,12 +169,12 @@ Order your fields data in ascending or descending order:
### Field display
You can customize which fields to display within a view. To hide a field, click **Options** > **Fields** and select the `-` button next to the field or click on the field column header and select **hide**.
You can customize which fields to display within a view. To hide a field, click **Options** > **Fields** and select the hide icon upon hover or click on the field column header and select **hide**.
You can rearrange fields by clicking their field column header and then press **Move Right** or **Move Left**.
### Opening Record
To open a record, click on the name in the first column. This action will open the corresponding Record page.
To open a record, click on the name in the first column. This action will open the corresponding Record page as a side panel.
<ArticleEditContent></ArticleEditContent>