Skip to content

Correct information about custom apps source code placement, build & third-party apps integration#53

Open
asvishnyakov wants to merge 2 commits into
mainfrom
fix/apps-folder
Open

Correct information about custom apps source code placement, build & third-party apps integration#53
asvishnyakov wants to merge 2 commits into
mainfrom
fix/apps-folder

Conversation

@asvishnyakov
Copy link
Copy Markdown
Member

@asvishnyakov asvishnyakov commented Apr 30, 2026

Depends on VirtoCommerce/vc-build#189, merge only after release

Summary

The single "register a new app" guide conflated two unrelated flows — building a custom back-office app from source and dropping a static redirect that hands users off to an external service. It also documented only the legacy App/ source layout, which vc-build still supports as a single-app fallback but cannot use for modules that ship more than one app.

This PR splits the guide and aligns the manifest reference accordingly.

Changes

  • Register Your Own App — documents the canonical Apps/[app_id] source layout (with App/ retained as the single-app legacy fallback) and uses Page Builder as the example, which also illustrates that registration is framework-agnostic: page-builder-shell is VC-Shell, page-builder-designer is Angular.
  • Register a Third-Party App — the static-redirect pattern with the actual PowerBiReportsController code.
  • Module.manifest — single source of truth for the <app> attributes, with cross-links to both guides.
  • vc-build is no longer yarn-only; the guide points to vc-build --help for overrides instead of pinning specific flag names.
  • Inbound links updated; the orphaned Connecting-to-Platform.md redirected to creating-custom-applications.md#initial-configuration.

@asvishnyakov asvishnyakov marked this pull request as draft April 30, 2026 19:34
Replace how-to-register-new-app.md with two purpose-specific guides
(register-your-own-app.md, register-third-party-app.md) using Page
Builder as the canonical Apps/[app_id] example, and consolidate app
attribute reference under the Apps section in 06-module-manifest-file.md.

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
@asvishnyakov asvishnyakov changed the title Correct information about custom apps source code & dist placement Correct information about custom apps source code placement, build & third-party apps integration May 1, 2026
@asvishnyakov asvishnyakov marked this pull request as ready for review May 1, 2026 03:21
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.

1 participant