workbenchdev / workbenchdev/Workbench

Support a URI scheme, to open demos from online documentation

Open
#438 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

enhancement
Dominant language
JavaScript
Stars
844
Forks
91
Avg merge
7h 12m
Merged PRs (30d)
1

Description

Loading example content from external sources is a complicated topic, and would involve thinking about a lot of security implications and committing to stable file formats.

On the other hand, if we can add support for a URI scheme something like workbench://demo/List View, we can link to interactive demos in Workbench from websites like gjs.guide easily and safely.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing how Workbench currently launches and selects demos, then compare the proposed workbench://demo/List View URI with the linking needs described for gjs.guide. Investigate the security and stable-format concerns raised in the issue; done should mean a documented, safe way for websites to open the intended interactive demo.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
desktop
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.