Skip to content

Commit e16b6d6

Browse files
Create LLMS.md on create-twenty-app (#18091)
Managed to create a many to many app with minimal instructions. File will need to be enriched with more pitfalls. --------- Co-authored-by: greptile-apps[bot] <165735046+greptile-apps[bot]@users.noreply.github.com>
1 parent 9626c7c commit e16b6d6

File tree

2 files changed

+13
-0
lines changed

2 files changed

+13
-0
lines changed
Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
## Base documentation
2+
3+
- Documentation: https://docs.twenty.com/developers/extend/capabilities/apps
4+
- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-sdk/src/cli/__tests__/apps/rich-app
5+
6+
## Common Pitfalls
7+
8+
- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it.
9+
- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar.

packages/create-twenty-app/src/constants/base-application/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,10 @@ yarn twenty function:execute # Execute a function with JSON payload
3636
yarn twenty app:uninstall # Uninstall app from workspace
3737
```
3838

39+
## LLMs instructions
40+
41+
Main docs and pitfalls are available in LLMS.md file.
42+
3943
## Learn More
4044

4145
To learn more about Twenty applications, take a look at the following resources:

0 commit comments

Comments
 (0)