Skip to content

Fix #406: Clarify console application setup — template vs. component#407

Merged
samdark merged 2 commits intomasterfrom
copilot/update-console-application-docs
Mar 30, 2026
Merged

Fix #406: Clarify console application setup — template vs. component#407
samdark merged 2 commits intomasterfrom
copilot/update-console-application-docs

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented Mar 30, 2026

The console applications page was misleading new users by suggesting composer require yiisoft/yii-console as the starting point, which only adds the component rather than scaffolding a runnable application.

Changes

  • src/guide/tutorial/console-applications.md
    • Add "Getting started" section to structure the guidance
    • Note that yiisoft/app and yiisoft/app-api already ship with console support — no extra steps needed
    • Recommend composer create-project yiisoft/app-console for standalone console apps, consistent with the web app onboarding flow
    • Replace bare composer require with a pointer to the yiisoft/yii-console package docs for the from-scratch integration path
# New standalone console app
composer create-project yiisoft/app-console your-project

# Adding to an existing project → see yiisoft/yii-console docs

📱 Kick off Copilot coding agent tasks wherever you are with GitHub Mobile, available on iOS and Android.

Copilot AI linked an issue Mar 30, 2026 that may be closed by this pull request
Copilot AI changed the title [WIP] Update console application installation instructions docs: clarify console application setup — template vs. component Mar 30, 2026
Copilot AI requested a review from samdark March 30, 2026 08:08
@samdark samdark marked this pull request as ready for review March 30, 2026 08:11
Copilot AI review requested due to automatic review settings March 30, 2026 08:11
@samdark samdark changed the title docs: clarify console application setup — template vs. component Fix #406: Clarify console application setup — template vs. component Mar 30, 2026
@samdark samdark merged commit 1927c73 into master Mar 30, 2026
3 checks passed
@samdark samdark deleted the copilot/update-console-application-docs branch March 30, 2026 08:11
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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/app and yiisoft/app-api include console support by default (with ./yii as the entry point).
  • Recommends composer create-project yiisoft/app-console for standalone console-only apps and links to package docs for manual integration.

Comment on lines +9 to 13
You can access the entry point as:

```
composer require yiisoft/yii-console
./yii
```
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
./yii
```

To add console support to an existing project from scratch, refer to the
Copy link

Copilot AI Mar 30, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"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.

Suggested change
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

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Problem on "Console applications"

3 participants