Fix #406: Clarify console application setup — template vs. component#407
Fix #406: Clarify console application setup — template vs. component#407
Conversation
Agent-Logs-Url: https://github.com/yiisoft/docs/sessions/4a67624e-24ad-4abb-bb99-85a0bea57861 Co-authored-by: samdark <47294+samdark@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Clarifies the Yii3 console applications guide so newcomers understand the difference between installing the yiisoft/yii-console component and scaffolding a runnable console application via a project template.
Changes:
- Adds a “Getting started” section that distinguishes template-based setup from component-only installation.
- Notes that
yiisoft/appandyiisoft/app-apiinclude console support by default (with./yiias the entry point). - Recommends
composer create-project yiisoft/app-consolefor standalone console-only apps and links to package docs for manual integration.
| You can access the entry point as: | ||
|
|
||
| ``` | ||
| composer require yiisoft/yii-console | ||
| ./yii | ||
| ``` |
There was a problem hiding this comment.
The phrasing "You can access the entry point as:" is grammatically awkward for this context. Consider rewording to something like "Run the entry point script:" / "Use the entry point script:" to make the instruction clearer.
| ./yii | ||
| ``` | ||
|
|
||
| To add console support to an existing project from scratch, refer to the |
There was a problem hiding this comment.
"To add console support to an existing project from scratch" reads as contradictory (an existing project vs. from scratch) and may confuse readers. Please rephrase to clarify whether this is about integrating into an existing app (non-template) or starting a new app with manual setup.
| To add console support to an existing project from scratch, refer to the | |
| To manually add console support to an existing project, refer to the |
The console applications page was misleading new users by suggesting
composer require yiisoft/yii-consoleas the starting point, which only adds the component rather than scaffolding a runnable application.Changes
src/guide/tutorial/console-applications.mdyiisoft/appandyiisoft/app-apialready ship with console support — no extra steps neededcomposer create-project yiisoft/app-consolefor standalone console apps, consistent with the web app onboarding flowcomposer requirewith a pointer to the yiisoft/yii-console package docs for the from-scratch integration path📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.