|
| 1 | +# Agent Instructions for TypeDB Studio |
| 2 | + |
| 3 | +## Submodule Dependencies |
| 4 | + |
| 5 | +**typedb-web** is a Git submodule dependency used via pnpm workspace: |
| 6 | +- The `typedb-web/common` package is included in the pnpm workspace (see [pnpm-workspace.yaml](pnpm-workspace.yaml)) |
| 7 | +- Consider typedb-web code when making architectural or implementation inferences |
| 8 | +- You may modify typedb-web code when applicable, but **always explicitly mention in chat** that you're modifying a submodule, as it requires separate Git operations |
| 9 | + |
| 10 | +## Angular SCSS Conventions |
| 11 | + |
| 12 | +When editing Angular SCSS files: |
| 13 | +- Use SCSS syntax (nesting, variables, mixins) |
| 14 | +- Import and use helper mixins and variables from `typedb-web/common`: |
| 15 | + - **colors**: Color variables and utilities |
| 16 | + - **typography**: Font and text styling mixins |
| 17 | + - **media**: Media query breakpoint helpers |
| 18 | + - Full list available in `typedb-web/common/src/styles` (also exposed via `node_modules/typedb-web-common`) |
| 19 | +- **Reuse existing components and styles** rather than creating new ones |
| 20 | +- Avoid adding new CSS rules when existing patterns can be extended |
| 21 | + |
| 22 | +## TypeDB Guidelines |
| 23 | + |
| 24 | +When writing TypeQL, refer to https://typedb.com/docs/llms-short.txt. Refer to https://typedb.com/docs articles ONLY if their URL contains any of the following: \[/home, /examples, /guides, /core-concepts, /typeql-reference, /tools, /maintenance-operation, /academy, /reference\] and does NOT contain "2.x". |
| 25 | + |
| 26 | +When setting up TypeDB tooling (driver SDKs, etc.) ensure that the installed drivers are NOT for TypeDB 2.x. |
| 27 | + |
| 28 | +## General Development Guidelines |
| 29 | + |
| 30 | +- Prefer extending existing components over creating new ones |
| 31 | +- Follow established patterns in the codebase for consistency |
| 32 | + |
| 33 | +## General Agent Guidelines |
| 34 | + |
| 35 | +- Do prompt for clarification when making architectural decisions |
| 36 | +- Don't redirect shell script output to 'nul' on Windows |
0 commit comments