mirror of
https://github.com/twentyhq/twenty.git
synced 2026-04-18 22:12:14 -04:00
9f97be67b1
## Summary Completes the migration of all documentation from twenty-website to a new Mintlify-powered documentation site at docs.twenty.com. ## Changes Made ### New Package: `twenty-docs` - ✅ Created new Mintlify documentation package - ✅ Migrated 95 content pages (user-guide, developers, twenty-ui) - ✅ Migrated 81 images - ✅ Converted all custom components to Mintlify native components - ✅ Configured navigation with 2 tabs and 94 pages - ✅ Added Helper AI Agent with searchArticles tool for docs search ### Updated: `twenty-website` - ✅ Added 11 redirect rules (301 permanent) in next.config.js - ✅ Removed all documentation content (111 files) - ✅ Removed documentation routes (user-guide, developers, twenty-ui) - ✅ Removed documentation components (9 files) - ✅ Updated keystatic.config.ts - ✅ Preserved all marketing/release pages ### Updated: Core Files - ✅ Updated README.md - docs links point to docs.twenty.com - ✅ Updated CONTRIBUTING.md - code quality link updated - ✅ Updated SupportDropdown.tsx - user guide link updated - ✅ Updated Footer.tsx - user guide link updated
94 lines
3.9 KiB
Plaintext
94 lines
3.9 KiB
Plaintext
---
|
|
title: Objects
|
|
info: "Learn about standard objects and how to create custom ones for your business needs."
|
|
image: /images/user-guide/objects/objects_orange.png
|
|
sectionInfo: Flexible data model designed to support your unique business processes
|
|
---
|
|
<Frame>
|
|
<img src="/images/user-guide/objects/objects_orange.png" alt="Header" />
|
|
</Frame>
|
|
|
|
## Standard Objects
|
|
|
|
Standard objects are predefined entities in your workspace to help you get started. They're part of a shared data model accessible to all users of Twenty. You can use them as-is, customize them or deactivate them.
|
|
|
|
<img src="/images/user-guide/objects/standard-objects.png"style={{width:'100%'}}/>
|
|
|
|
### People
|
|
|
|
The `People` object stores your contacts. It includes contact details and interaction history, so you can see all your customer interactions in one place.
|
|
|
|
### Company
|
|
|
|
The `Companies` object stores your business accounts. It includes details like industry, size and location. Companies connect to both `People` and `Opportunities` objects.
|
|
|
|
### Opportunities
|
|
|
|
The `Opportunities` object stores deal-related data. It tracks the progression of potential sales, from prospecting to closure, recording stages, deal sizes, associated account, and expected close date. You can view your sales pipeline in a kanban layout.
|
|
|
|
## Custom objects
|
|
|
|
Custom objects let you store information that's unique to your organization and that standard objects can't handle. For example, if you're SpaceX, you may want to create a custom object for Rockets and Launches.
|
|
|
|
<img src="/images/user-guide/objects/custom-objects.png"style={{width:'100%'}}/>
|
|
|
|
### 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).
|
|
|
|
|
|
<div style={{padding:'71.24% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
|
<iframe
|
|
src="https://player.vimeo.com/video/926288174?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
|
frameBorder="0"
|
|
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
|
style={{
|
|
position:'absolute',
|
|
top:0,
|
|
left:0,
|
|
width:'100%',
|
|
height:'100%',
|
|
borderRadius: '16px',
|
|
border:'2px solid black'
|
|
}}
|
|
title="Export data"
|
|
></iframe>
|
|
</div>
|
|
<script src="https://player.vimeo.com/api/player.js"></script>
|
|
|
|
3. Click on `+ New object` at the top. 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."
|
|
|
|
<Warning>
|
|
The singular and plural names must be different. This is required for our GraphQL API to work properly.
|
|
</Warning>
|
|
|
|
<div style={{padding:'71.24% 0 0 0', position:'relative', margin: '32px 0px 0px'}}>
|
|
<iframe
|
|
src="https://player.vimeo.com/video/926293493?autoplay=1&loop=1&autopause=0&background=1&app_id=58479"
|
|
frameBorder="0"
|
|
allow="autoplay; fullscreen; picture-in-picture; clipboard-write"
|
|
style={{
|
|
position:'absolute',
|
|
top:0,
|
|
left:0,
|
|
width:'100%',
|
|
height:'100%',
|
|
borderRadius: '16px',
|
|
border:'2px solid black'
|
|
}}
|
|
title="Export data"
|
|
></iframe>
|
|
</div>
|
|
<script src="https://player.vimeo.com/api/player.js"></script>
|
|
|
|
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.
|
|
|
|
<img src="/images/user-guide/objects/customize-fields.png"style={{width:'100%'}}/>
|
|
|
|
**Note:** If you're not sure whether a new object or field is needed, check [this article](/user-guide/data-model/customize-your-data-model) for guidance on designing your data model.
|
|
|
|
|