Improved create-twenty-app documentation for AI coding agents

[Bredo]

Added a bit of enhanced context for better agentic coding, based on this Discord conversation.

[github-actions]

Welcome!

Hello there, congrats on your first PR! We're excited to have you contributing to this project.
By submitting your Pull Request, you acknowledge that you agree with the terms of our Contributor License Agreement.

Generated by 🚫 dangerJS against f2ef9c9

[cubic-dev-ai]

2 issues found across 3 files

Prompt for AI agents (unresolved issues)

Check if these issues are valid — if so, understand the root cause of each and fix them. If appropriate, use sub-agents to investigate and fix each issue separately.


<file name="packages/create-twenty-app/src/constants/template/AGENT.md">

<violation number="1" location="packages/create-twenty-app/src/constants/template/AGENT.md:31">
P2: Logic functions are documented with the wrong filename pattern; the generator uses `*.function.ts`, not plain `*.ts`.</violation>

<violation number="2" location="packages/create-twenty-app/src/constants/template/AGENT.md:37">
P3: Navigation menu items are documented with an incomplete filename pattern; the actual convention includes the `.navigation-menu-item.ts` suffix.</violation>
</file>

_{Reply with feedback, questions, or to request a fix. Tag @cubic-dev-ai to re-run a review.}

[cubic-dev-ai]

P2: Logic functions are documented with the wrong filename pattern; the generator uses *.function.ts, not plain *.ts.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At packages/create-twenty-app/src/constants/template/AGENT.md, line 31:

<comment>Logic functions are documented with the wrong filename pattern; the generator uses `*.function.ts`, not plain `*.ts`.</comment>

<file context>
@@ -12,3 +19,22 @@
+| -------------------- | ------------------------------------ | ------------------------------------- |
+| Object               | `yarn twenty add object`             | `src/objects/<name>.ts`               |
+| Field                | `yarn twenty add field`              | `src/fields/<name>.ts`                |
+| Logic function       | `yarn twenty add logicFunction`      | `src/logic-functions/<name>.ts`       |
+| Front component      | `yarn twenty add frontComponent`     | `src/front-components/<name>.tsx`     |
+| Role                 | `yarn twenty add role`               | `src/roles/<name>.ts`                 |
</file context>

Suggested change

	| Logic function | `yarn twenty add logicFunction` | `src/logic-functions/<name>.ts` |
	| Logic function | `yarn twenty add logicFunction` | `src/logic-functions/<name>.function.ts` |

[cubic-dev-ai]

P3: Navigation menu items are documented with an incomplete filename pattern; the actual convention includes the .navigation-menu-item.ts suffix.

Prompt for AI agents

Check if this issue is valid — if so, understand the root cause and fix it. At packages/create-twenty-app/src/constants/template/AGENT.md, line 37:

<comment>Navigation menu items are documented with an incomplete filename pattern; the actual convention includes the `.navigation-menu-item.ts` suffix.</comment>

<file context>
@@ -12,3 +19,22 @@
+| Skill                | `yarn twenty add skill`              | `src/skills/<name>.ts`                |
+| Agent                | `yarn twenty add agent`              | `src/agents/<name>.ts`                |
+| View                 | `yarn twenty add view`               | `src/views/<name>.ts`                 |
+| Navigation menu item | `yarn twenty add navigationMenuItem` | `src/navigation-menu-items/<name>.ts` |
+| Page layout          | `yarn twenty add pageLayout`         | `src/page-layouts/<name>.ts`          |
+
</file context>

Suggested change

	| Navigation menu item | `yarn twenty add navigationMenuItem` | `src/navigation-menu-items/<name>.ts` |
	| Navigation menu item | `yarn twenty add navigationMenuItem` | `src/navigation-menu-items/<name>.navigation-menu-item.ts` |