docs: recommend the create-scaffold generator for new Edge Apps - #884
Merged
Conversation
- scaffold new Edge Apps first with 'bunx @screenly/edge-apps create' instead of starting from a reference app - keep consulting reference apps for anything past the generator's basic output (integrations, Sentry, screenly_qc.yml, complex UI) - update the id-registration step to match the generator's actual behavior (no blank id field, no screenly_qc.yml by default)
|
Failed to generate code suggestions for PR |
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the internal “create an Edge App” skill doc to recommend starting new Screenly Edge Apps from the @screenly/edge-apps scaffold generator, and clarifies what the scaffold does (and doesn’t) produce so maintainers know when to consult reference apps.
Changes:
- Recommend scaffolding with
bunx @screenly/edge-apps create <app-name>instead of copying a reference app. - Clarify generator limitations (e.g., no
screenly_qc.ymlby default) and direct readers to reference apps for more complex setups. - Update the app registration step to match the generator workflow (populate a real
idvia CLI).
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- use >=1.2.0 instead of the semantically inconsistent ^1.2.0 or later - drop the manual 'screenly edge-app create --in-place' registration step; standalone Edge App repos register/initialize apps via their own GitHub Actions workflow, not a manual command right after scaffolding
nicomiguelino
marked this pull request as ready for review
July 19, 2026 19:33
|
Failed to generate code suggestions for PR |
Standalone Edge App repos add the edge-apps-claude-config repo as a .claude submodule for Claude AI configuration; mention it right after the scaffold generator step.
Contributor
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 1 out of 1 changed files in this pull request and generated 1 comment.
Comments suppressed due to low confidence (1)
.claude/skills/create-an-edge-app/SKILL.md:15
- The placeholder
<app-name>is a bit ambiguous (could be read as a human display name). Since the generator argument is meant to be a kebab-case slug/directory name, calling it out explicitly avoids repeating past confusion around “name” vs “slug”.
- It's recommended to scaffold the new Edge App first with the `@screenly/edge-apps` create-scaffold generator, following the `kebab-case` naming convention for the app name:
```bash
bunx @screenly/edge-apps create <app-name>
This produces a minimal, working app — manifest, index.html, src/main.ts, and the standard dev/build/lint/test/deploy scripts — already wired up to the library's conventions. Requires @screenly/edge-apps >=1.2.0.
</details>
- clarify the edge-apps-claude-config submodule step only applies to standalone Edge App repos, since this monorepo already has its own .claude/ - mention git submodule update --init for teammates cloning afterward
salmanfarisvp
approved these changes
Jul 20, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
bunx @screenly/edge-apps create <app-name>(added in@screenly/edge-apps1.2.0) instead of starting from a reference app.screenly_qc.yml, complex UI — since the generator only produces a minimal app.idplaceholder, noscreenly_qc.ymlby default).