admin/twenty
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Documentation + docker-compose.yml update (#9653)

Browse Source 
Related to #9469 #9455 #9419 #8943
This commit is contained in:
BOHEUS
2025-01-16 09:43:27 +00:00
committed by GitHub
parent 5bae5a9f7c
commit 34ddeade83
7 changed files with 72 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
packages/twenty-website/src/content/developers/frontend-development/hotkeys.mdx
View File

@ -16,9 +16,9 @@ For example, if you have a page that listens for the Enter key, and a modal that
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.
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 ?
## 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
@ -131,7 +131,7 @@ It's important to use this pattern when you're not sure that just using a useEff
Those conflicts can be hard to debug, and it might happen more often than not with useEffects.
## What is a hotkey scope ?
## 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.
@ -171,7 +171,7 @@ export const currentHotkeyScopeState = createState<HotkeyScope>({
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 ?
## 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.

2
packages/twenty-website/src/content/developers/frontend-development/work-with-figma.mdx
View File

@ -31,7 +31,7 @@ On the left sidebar, you can access the different pages of Twenty's Figma. This
## 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.
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