Fix docs with missing npx #8288
Conversation
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
There was a problem hiding this comment.
PR Summary
This PR standardizes command usage across documentation by updating frontend and backend commands to consistently use npx nx prefix instead of just nx or yarn.
- Updated command format in
packages/twenty-website/src/content/developers/frontend-development/frontend-commands.mdxfromnxtonpx nx run twenty-front:<command> - Added PostgreSQL permission notes in
packages/twenty-website/src/content/developers/local-setup.mdxabout usingsudo -u postgresprefix - Added migration commands section in
packages/twenty-website/src/content/developers/backend-development/server-commands.mdxfor TypeORM and Workspace objects - Fixed inconsistent references to
yarn storybook:serve:devin Storybook test commands
3 file(s) reviewed, 4 comment(s)
Edit PR Review Bot Settings | Greptile
| @@ -7,38 +7,55 @@ image: /images/user-guide/kanban-views/kanban.png | |||
| ## Useful commands | |||
|
|
|||
| These commands should be executed from packages/twenty-server folder. | |||
| From any other folder you can run `npx nx <command>` twenty-server. | |||
| From any other folder you can run `npx nx <command> twenty-server` (or `npx nx run twenty-server:<command>`). | |||
There was a problem hiding this comment.
logic: Inconsistent command format in explanation - shows <command> twenty-server but examples use run twenty-server:<command>
|
|
||
| ### First time setup | ||
|
|
||
| ``` | ||
| npx nx database:reset # setup the database with dev seeds | ||
| npx nx twenty-server database:reset # setup the database with dev seeds |
There was a problem hiding this comment.
style: Command format inconsistent with other examples - should be npx nx run twenty-server:database:reset for consistency
| @@ -9,28 +9,32 @@ image: /images/user-guide/create-workspace/workspace-cover.png | |||
| ### Starting the app | |||
|
|
|||
| ```bash | |||
| nx start twenty-front | |||
| npx nx start twenty-front | |||
There was a problem hiding this comment.
logic: Command syntax inconsistent with other commands. Should be 'npx nx run twenty-front:start' to match pattern
| npx nx run twenty-front:storybook:test # run tests # (needs yarn storybook:serve:dev to be running) | ||
| npx nx run twenty-front:storybook:coverage # (needs yarn storybook:serve:dev to be running) |
There was a problem hiding this comment.
logic: Comments reference 'yarn storybook:serve:dev' but commands use 'npx nx run'. Update comments to match actual command syntax
Related to #8082
Created this PR on purpose after both #8083 and #8161 were closed and respective branches were deleted by the author