Skip to content

[Bug]: Unclear instruction for enabling frontend development mode for admin panel customization #439

@nwazuo

Description

@nwazuo

Link to the documentation page or resource

https://strapi.io/documentation/developer-docs/latest/development/admin-customization.html#customization-options

Describe the bug

The part of the documentation that describes how to enable the front-end development mode for admin panel customization tripped me up(isn't very clear).

strapi develop --watch-admin

The documentation assumes that the developer installed strapi as a global package which is hardly ever the case and is even recommended against by strapi team members(saw it on an issue, can't remember which).

Additional context

I kept trying to figure out what I did wrong as my strapi app couldn't start up in development mode as I tried running
npm run develop --watch-admin . I assumed to use this command because I don't have strapi installed as a global npm package.

I eventually figured out the correct command

npm run develop -- --watch-admin

The -- separator made the difference and isn't very obvious for someone not very familiar with how to pass params to npm scripts.

Suggested improvements or fixes

Update the doc to use the included npm script version for starting the frontend dev mode (and not the global strapi command).

npm run develop -- --watch-admin

Or include a warning on how to use the strapi develop --watch-admin command correctly with local strapi package installation(which is equivalent to the command above this paragraph).

Related issue(s)/PR(s)

No response

Metadata

Metadata

Assignees

Labels

issue: quick fixIssues that could be fixed quickly, with small- to medium-sized PRspr: fixUsed on the docs repo for anything that is not "new" or "updated" content: chore, typos, fixes, etc.status: pending reproductionWaiting for free time to reproduce the issue, or more informationtarget: v3Documentation PRs/issues targeting content from docs-v3.strapi.io (v3 branch)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions