diff --git a/packages/create-twenty-app/src/constants/base-application/LLMS.md b/packages/create-twenty-app/src/constants/base-application/LLMS.md new file mode 100644 index 0000000000..421003481f --- /dev/null +++ b/packages/create-twenty-app/src/constants/base-application/LLMS.md @@ -0,0 +1,9 @@ +## Base documentation + +- Documentation: https://docs.twenty.com/developers/extend/capabilities/apps +- Rich app example: https://github.com/twentyhq/twenty/tree/main/packages/twenty-sdk/src/cli/__tests__/apps/rich-app + +## Common Pitfalls + +- Creating an object without an index view associated. Unless this is a technical object, user will need to visualize it. +- Creating a view without a navigationMenuItem associated. This will make the view available on the left sidebar. diff --git a/packages/create-twenty-app/src/constants/base-application/README.md b/packages/create-twenty-app/src/constants/base-application/README.md index 35ea775887..f12837b91e 100644 --- a/packages/create-twenty-app/src/constants/base-application/README.md +++ b/packages/create-twenty-app/src/constants/base-application/README.md @@ -36,6 +36,10 @@ yarn twenty function:execute # Execute a function with JSON payload yarn twenty app:uninstall # Uninstall app from workspace ``` +## LLMs instructions + +Main docs and pitfalls are available in LLMS.md file. + ## Learn More To learn more about Twenty applications, take a look at the following resources: