Commit graph

77 commits

Author SHA1 Message Date
Félix Malfait
5d438bb70c
Docs: restructure navigation, add halftone illustrations, clean up hero images (#19728)
## Summary

- **New Getting Started section** with quickstart guide and restructured
navigation
- **Halftone-style illustrations** for User Guide and Developer
introduction cards using a Canvas 2D filter script
- **Removed hero images** (`image:` frontmatter + `<Frame><img>` blocks)
from all user-guide article pages
- **Cleaned up translations** (13 languages): removed hero images and
updated introduction cards to use halftone style
- **Cleaned up twenty-ui pages**: removed outdated hero images from
component docs
- **Deleted orphaned images**: `table.png`, `kanban.png`
- **Developer page**: fixed duplicate icon, switched to 3-column layout

## Test plan

- [ ] Verify docs site builds without errors
- [ ] Check User Guide introduction page renders halftone card images in
both light and dark mode
- [ ] Check Developer introduction page renders 3-column layout with
distinct icons
- [ ] Confirm article pages no longer show hero images at the top
- [ ] Spot-check a few translated pages to ensure hero images are
removed

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
Co-authored-by: github-actions <github-actions@twenty.com>
2026-04-21 09:13:55 +02:00
Thomas des Francs
3ee1b528a1
Website last fixes (#19895)
Co-authored-by: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-04-21 05:43:06 +00:00
Sri Hari Haran Sharma
70a060b4ee
docs: fix contributor docs links and typos (#18637)
## Summary

This PR fixes several small documentation issues in the contributor and
setup guides:

- fixes broken docs links in the root README
- corrects multiple typos and capitalization issues in contributor docs
- fixes malformed Markdown for the Redis command in local setup
- improves wording in the Docker Compose self-hosting guide

## Changes

- updated README installation links to the current docs routes
- changed `Open-source` to `open-source`
- fixed `specially` -> `especially` in the frontend style guide
- normalized `MacOS` -> `macOS`, `powershell` -> `PowerShell`, and
`Postgresql` -> `PostgreSQL`
- replaced the invalid `localhost:5432` Markdown link with inline code
- fixed the malformed fenced code block for `brew services start redis`
- cleaned up Redis naming/capitalization and a few grammar issues in the
setup docs
- improved the warning and environment-variable wording in the Docker
Compose guide

## Testing

- not run; docs-only changes

---------

Co-authored-by: Charles Bochet <charlesBochet@users.noreply.github.com>
2026-03-14 12:54:31 +01:00
Charles Bochet
7a2e397ad1
Complete linaria migration (#18361)
## Summary

Completes the migration of the frontend styling system from **Emotion**
(`@emotion/styled`, `@emotion/react`) to **Linaria** (`@linaria/react`,
`@linaria/core`), a zero-runtime CSS-in-JS library where styles are
extracted at build time.

This is the final step of the migration — all ~494 files across
`twenty-front`, `twenty-ui`, `twenty-website`, and `twenty-sdk` are now
fully converted.

## Changes

### Styling Migration (across ~480 component files)
- Replaced all `@emotion/styled` imports with `@linaria/react`
- Converted runtime theme access patterns (`({ theme }) => theme.x.y`)
to build-time `themeCssVariables` CSS custom properties
- Replaced `useTheme()` hook (from Emotion) with
`useContext(ThemeContext)` where runtime theme values are still needed
(e.g., passing colors to non-CSS props like icon components)
- Removed `@emotion/react` `css` helper usages in favor of Linaria
template literals

### Dependency & Configuration Changes
- **Removed**: `@emotion/react`, `@emotion/styled` from root
`package.json`
- **Added**: `@wyw-in-js/babel-preset`, `next-with-linaria` (for
twenty-website SSR support)
- Updated Nx generator defaults from `@emotion/styled` to
`@linaria/react` in `nx.json`
- Simplified `vite.config.ts` (removed Emotion-specific configuration)
- Updated `twenty-website/next.config.js` to use `next-with-linaria` for
SSR Linaria support

### Storybook & Testing
- Removed `ThemeProvider` from Emotion in Storybook previews
(`twenty-front`, `twenty-sdk`)
- Now relies solely on `ThemeContextProvider` for theme injection

### Documentation
- Removed the temporary `docs/emotion-to-linaria-migration-plan.md`
(migration complete)
- Updated `CLAUDE.md` and `README.md` to reflect Linaria as the styling
stack
- Updated frontend style guide docs across all locales

## How it works

Linaria extracts styles at build time via the `@wyw-in-js/vite` plugin.
All expressions in `styled` template literals must be **statically
evaluable** — no runtime theme objects or closures over component state.

- **Static styles** use `themeCssVariables` which map to CSS custom
properties (`var(--theme-color-x)`)
- **Runtime theme access** (for non-CSS use cases like icon `color`
props) uses `useContext(ThemeContext)` instead of Emotion's `useTheme()`
2026-03-04 00:50:06 +01:00
Charles Bochet
2674589b44
Remove any recoil reference from project (#18250)
## Remove all Recoil references and replace with Jotai

### Summary

- Removed every occurrence of Recoil from the entire codebase, replacing
with Jotai equivalents where applicable
- Updated `README.md` tech stack: `Recoil` → `Jotai`
- Rewrote documentation code examples to use
`createAtomState`/`useAtomState` instead of `atom`/`useRecoilState`, and
removed `RecoilRoot` wrappers
- Cleaned up source code comment and Cursor rules that referenced Recoil
- Applied changes across all 13 locale translations (ar, cs, de, es, fr,
it, ja, ko, pt, ro, ru, tr, zh)
2026-02-26 10:28:40 +01:00
Félix Malfait
ad88108b28
Update README: add E2B logo and improve heading (#18144)
## Summary
- Add E2B logo to the Thanks section (after Crowdin, same height)
- Rename section heading from "Does the world need another CRM?" to "Why
Twenty" for a more confident, direct tone

## Test plan
- [ ] Verify E2B logo renders correctly on GitHub README
- [ ] Confirm all other logos still display properly

Made with [Cursor](https://cursor.com)

Co-authored-by: Cursor <cursoragent@cursor.com>
2026-02-21 15:02:11 +01:00
Félix Malfait
7c854ba816
Remove Hacktoberfest from README (#15530)
As per title
2025-11-03 10:03:03 +01:00
Abdul Rahman
9f97be67b1
Migrate documentation to Mintlify and configure 301 redirects (#15502)
## 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
2025-10-31 17:44:14 +01:00
Thomas des Francs
4d8b68cf4d
Hacktoberfest 2025 Banner (#14843)
Co-authored-by: Charles Bochet <charles@twenty.com>
2025-10-02 16:17:55 +02:00
Félix Malfait
380e8aff86
Remove product hunt (#13090) 2025-07-08 10:07:41 +02:00
Thomas des Francs
2ca43e18e9
Removed PH from the README (#12894) 2025-06-26 11:46:09 +02:00
Vicky Wang
1d13b087ed
Minor changelog updates + other misc issues (#12882)
^^as per summary written in the title :)

Co-authored-by: Vicky Wang <vw92@cornell.edu>
2025-06-25 17:45:07 +02:00
Guillim
8d3084ef16
fixing images url to main branch (#12862)
Simple fix for the readme on github
2025-06-25 10:47:39 +02:00
Vicky Wang
378e7cf6f1
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>
2025-06-25 10:19:04 +02:00
Félix Malfait
5343dd62d6
Update readme with partner logos (#11722)
Recognize the role of Greptile/Sentry/Crowdin/Chromatic which give
generous open source plans + some cleanup
2025-04-24 16:09:43 +02:00
Félix Malfait
2c0f66dab6
Progress on translations (#10142) 2025-02-12 08:13:29 +01:00
Félix Malfait
bb24c97f80
Translations - Crowdin, Set workspace member locale on signup, and optimizations (#10091)
More progress on translations:
- Migrate from translations.io to crowdin
- Optimize performance and robustness 
- Set workspaceMember/user locale upon signup
2025-02-09 22:10:41 +01:00
Charles Bochet
591301f7ce
Remove demo from readme as users can create free trial on production (#9952)
We have recently introduced the possibility to sign up on Twenty cloud
without having to input a credit card which makes the demo.twenty.com
useless. Deprecating it!
2025-01-31 15:36:30 +01:00
Andrii Bodnar
ac8c0c72cc
docs: add Lingui to the Readme (#9884)
This PR adds Lingui to the translation tools in the Stack section of the
Readme, based on the suggestion in the comment
https://github.com/lingui/js-lingui/issues/2159#issuecomment-2618922147
2025-01-28 14:48:46 +01:00
Félix Malfait
2efc71b5cb
Add first real translations + translation.io (#9715) 2025-01-17 14:59:19 +01:00
Etienne
26058f3e25
Update ChooseYourPlan page with new trial period options (#9628)
### Context
- Update /plan-required page to let users get free trial without credit
card plan
- Update usePageChangeEffectNavigateLocation to redirect paused and
canceled subscription (suspended workspace) to /settings/billing page

### To do

- [x] Update usePageChangeEffectNavigateLocation test
- [x] Update ChooseYourPlan sb test



closes #9520

---------

Co-authored-by: etiennejouan <jouan.etienne@gmail.com>
2025-01-16 11:10:36 +01:00
BOHEUS
34ddeade83
Documentation + docker-compose.yml update (#9653)
Related to #9469 #9455 #9419 #8943
2025-01-16 10:43:27 +01:00
Félix Malfait
059c4ab411
Update README (#9351)
Needed a new description
2025-01-05 14:11:19 +01:00
Félix Malfait
97f5a5b8a5
Pass Billing Checkout var in url to bypass credit card (#9283) 2024-12-31 14:48:00 +01:00
Shubham Bankar
aa8b0ff04a
Update README.md (#8673)
grammatical issue fixed
2024-11-22 11:55:56 +01:00
BOHEUS
f70ed7fb5a
Remove oss.gg banner from README.md (#8275) 2024-11-01 11:28:56 +01:00
Vijay
a8c07bf77f
update: Default Demo Login Credentials to noah@demo.dev (#7308)
This PR updates the default login credentials for the demo environment.
The current default is set to tim@apple.dev, and we want to change it
to:

Email: `noah@demo.dev`
Password: `Applecar2025`

Changes:

- Updated default demo login email from tim@apple.dev to noah@demo.dev

Resolves #7304

---------

Co-authored-by: Félix Malfait <felix@twenty.com>
2024-10-02 08:31:53 +02:00
Thomas des Francs
43ded024eb
Update README.md with Hacktoberfest banner (#7372)
Hacktoberfest banner on readme!

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2024-10-01 15:29:08 +02:00
Muhamad Fahri Mulyawan
a850b43c52
add contibuting_example.md (#6998)
add a contributing_example.md on folder .github

---------

Co-authored-by: Félix Malfait <felix@twenty.com>
2024-09-12 12:31:34 +02:00
Félix Malfait
af8c637355
Temporary fix README (#5814)
Emergency fix for broken readme images
2024-06-11 10:18:08 +02:00
Ady Beraud
ff1bca1816
Docs modifications (#5804)
- Fixes #5504
- Fixes #5503
- Return 404 when the page does not exist
- Modified the footer in order to align it properly
- Removed "noticed something to change" in each table of content
- Fixed the URLs of the edit module 
- Added the edit module to Developers
- Fixed header style on the REST API page.
- Edited the README to point to Developers
- Fixed selected state when clicking on sidebar elements

---------

Co-authored-by: Félix Malfait <felix.malfait@gmail.com>
2024-06-11 09:45:17 +02:00
Brandon Yee
86caf00fb8
Update README.md (#5345)
Fixed Grammar
2024-05-11 09:30:03 +02:00
Thomas Trompette
04efe5c455
Update demo link (#4483)
* Update demo link

* Update doc

---------

Co-authored-by: Thomas Trompette <thomast@twenty.com>
2024-03-14 17:51:27 +01:00
Thomas des Francs
4a95798411
Update of the readme with updated visuals (#4041)
* README udpated illustrations & taglines

* Delete packages/twenty-docs/static/img/create-tasks-dark.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/create-tasks-light.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/follow-your-deals-dark.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/follow-your-deals-light.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/rich-notes-dark.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/rich-notes-light.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/shortcut-navigation-dark.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/shortcut-navigation-light.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/visualise-customer-dark.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/visualise-customer-light.png

Deleting depreciated illustration

* Delete packages/twenty-docs/static/img/logo-square-light.svg

Logo not part of the visual identity

* Updated a typo
2024-02-19 11:40:26 +01:00
Mohamed Houssein Douici
8d06d37f73
docs: change the slug for local setup link (#3947)
fix: change the slug for local setup link
2024-02-13 23:20:07 +01:00
Félix Malfait
a5989a470c
Improve Documentation (#3795)
* Begin docs improvement

* Keep improving documentation

* Upgrade Docusarus

* Fix broken links
2024-02-05 15:01:37 +01:00
Thomas des Francs
d9d3be69be
Updating the readme cover & title (#3632)
* Delete packages/twenty-docs/static/img/preview-light.png

* Delete packages/twenty-docs/static/img/preview-dark.png

* Replacing preview files with updated version

* Updating readme title
2024-01-26 11:00:24 +01:00
Ikko Eltociear Ashimine
974498d57a
Update README.md (#3189)
chose -> choose
2024-01-03 11:58:33 +01:00
Félix Malfait
f6041f560d
Readme update with demo (#3042) 2023-12-17 16:26:54 +01:00
Kanav Arora
f91bb35573
2921-fix: readme img path fix (#2922) 2023-12-11 08:33:14 +01:00
Akassh
ffd2758ebb
Repoint README link for local env dev set up. (#2025) 2023-10-15 09:18:16 +02:00
flo merian
bd9a6c56fe
doc: Update README.md with quick links in the Features section (#1994)
Added quick links in the Features section
2023-10-13 11:37:34 +02:00
Tom Doe
73617e3534
Fix: Broken "local-setup" link in README.md (#1946)
Fixed a broken link to "Local Setup" in the readme.
2023-10-09 16:32:51 +02:00
Charles Bochet
edc060fce7
Introduce UI Components documentation (#1926)
* new contributor guide folder architecture

* update content pass 1

* Prepare UI component folder to receive componentns

* Add component doc example for button

* Fix broken links

* Fix broken links

* Fix images
2023-10-08 13:21:54 +02:00
Nimra Ahmed
7b6ee4e0bf
Update README and Documentation (#1875)
* Added Overview page

* Revised Getting Started page

* Minor revision

* Edited readme, minor modifications to docs

* Removed sweep.yaml, .devcontainer, .ergomake

* Moved security.md to .github, added contributing.md

* changes as per code review
2023-10-07 11:24:44 +02:00
bosiraphael
35fb2576b7
added figma link to README.md (#1835)
* added figma link to README.md

* added figma to the recommended extensions for the project

* updated useful tips in 'work with Figma' section of the docs to add Figma extension for VSCode

* removing yarn.lock

* modified Figma extension docs in 'Work with Figma'

* added Mdx Preview extension to recommended extensions
2023-10-03 12:50:05 +02:00
Thomas des Francs
9dbc7942b6
Update README.md (#1251)
Updated the next steps
2023-08-17 12:19:11 -07:00
Max Mergenthaler
663c4d5c3f
doc: Update README.md with suggestions (#773)
Update README.md with suggestions

I changed some minor stuff for readability.
2023-07-20 08:34:19 +02:00
Charles Bochet
60b50387a7
Update readmes (#770)
* Update readmes

* Update readmes

* Update readmes
2023-07-19 18:16:33 -07:00
Andy Rae
cafb3259c6
Update README.md (#762) 2023-07-19 14:17:25 -07:00