Skip to content

Fix #360: Add package design guide#462

Merged
samdark merged 6 commits into
masterfrom
docs/package-design-guide
May 29, 2026
Merged

Fix #360: Add package design guide#462
samdark merged 6 commits into
masterfrom
docs/package-design-guide

Conversation

@samdark
Copy link
Copy Markdown
Member

@samdark samdark commented May 29, 2026

Closes #360.

Summary

  • add a guide for designing Yii-aware Composer packages that provide application configuration
  • cover config groups, routes, DI providers, params, assets, events, migrations, translations, themes, and console commands
  • add the page to the guide TOC and VitePress sidebar

Checks

  • npm run build
  • npm run check-links -- src/guide/structure/designing-packages.md src/guide/structure/package.md src/guide/index.md

Copilot AI review requested due to automatic review settings May 29, 2026 10:12
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

Adds a new guide page describing how to design Composer packages that integrate with a Yii3 application via configuration. It walks through package layout, the extra.config-plugin metadata, parameters, DI definitions and providers, routes, events, assets, migrations, translations, themes, console commands, and application-override guidance. The page is wired into the guide index, the VitePress sidebar, and cross-linked from package.md.

Changes:

  • Add src/guide/structure/designing-packages.md covering all Yii3 package integration points listed in #360.
  • Link the new page from src/guide/structure/package.md and the guide index.
  • Register the page in the VitePress sidebar under Structure.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
src/guide/structure/designing-packages.md New guide page documenting Yii3 package design across config groups, DI, routes, events, assets, migrations, translations, themes, and commands.
src/guide/structure/package.md Cross-link from the existing Packages page to the new designing-packages page.
src/guide/index.md Add the new page to the Structure section of the guide TOC.
src/.vitepress/config.js Add the new page to the VitePress sidebar under Structure.

Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/guide/structure/designing-packages.md
Comment thread src/guide/structure/designing-packages.md Outdated
Comment thread src/.vitepress/config.js
Comment thread src/guide/structure/designing-packages.md Outdated
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

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

Comment thread src/guide/structure/designing-packages.md
Comment thread src/guide/structure/designing-packages.md
@samdark samdark changed the title Add package design guide Fix #360: Add package design guide May 29, 2026
@samdark samdark merged commit f99263d into master May 29, 2026
7 checks passed
@samdark samdark deleted the docs/package-design-guide branch May 29, 2026 19:03
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.

Docs on how to design your own package

3 participants