Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Provide a command to launch getting started for a particular extension #119725

Closed
Tyriar opened this issue Mar 23, 2021 · 7 comments
Closed

Provide a command to launch getting started for a particular extension #119725

Tyriar opened this issue Mar 23, 2021 · 7 comments
Assignees
Labels
api feature-request Request for new features or functionality getting-started verified Verification succeeded
Milestone

Comments

@Tyriar
Copy link
Member

Tyriar commented Mar 23, 2021

When I adopt getting started in Luna Paint I'd like to tell the users that they can access the getting started guide/feature overview from within the tool by running some command. As such I'd like to be able to run some command with an arg being my extension ID to open it directly. That way I could wrap it in my own command.

Perhaps this should open to the side by default?

@JacksonKearl JacksonKearl added this to the April 2021 milestone Mar 29, 2021
@JacksonKearl JacksonKearl added the feature-request Request for new features or functionality label Apr 28, 2021
@Tyriar Tyriar modified the milestones: April 2021, May 2021 Apr 30, 2021
JacksonKearl pushed a commit that referenced this issue May 21, 2021
@JacksonKearl
Copy link
Contributor

Added a workbench.action.openWalkthrough(fullyQualifiedWalkthroughID: string, toSide?: boolean):

vscode.commands.executeCommand('workbench.action.openWalkthrough', 'jakearl.md-to-html#exampleProject', true);

@Tyriar
Copy link
Member Author

Tyriar commented May 25, 2021

When I call either of these:

// <extid>#<stepid>
commands.executeCommand('workbench.action.openWalkthrough', 'tyriar.luna-paint#luna.interfaceOverview', true);
// <extid>#<walkthroughid>
commands.executeCommand('workbench.action.openWalkthrough', 'tyriar.luna-paint#exampleProject', true);

This is the result:

Screen Shot 2021-05-25 at 5 39 36 AM

Am I doing something wrong? Also should open to side only open to side when there is an existing editor in the first group?

@Tyriar Tyriar reopened this May 25, 2021
bpasero pushed a commit to bpasero/vscode that referenced this issue May 25, 2021
bpasero pushed a commit to bpasero/vscode that referenced this issue May 25, 2021
@Tyriar
Copy link
Member Author

Tyriar commented May 30, 2021

I was missing the capital T

@Tyriar Tyriar closed this as completed May 30, 2021
@Tyriar
Copy link
Member Author

Tyriar commented May 30, 2021

Actually I think this should be case insensitive just like workbench.action.openIssueReporter

@JacksonKearl
Copy link
Contributor

Going to close this out for verification this milestone, opened #125414 to track case insensitivity

@Tyriar Tyriar added the verified Verification succeeded label Jun 3, 2021
@github-actions github-actions bot locked and limited conversation to collaborators Jul 18, 2021
@karrtikr
Copy link
Contributor

Can anyone here help me with how to highlight a specific step/tile in a walkthrough? That does not seem to be documented but according to a quoted text it seems it should be possible:

you can run the command workbench.action.openWalkthrough with args
{ "category": "walkthroughID" (with hash separating ext id and walkthrough name)', "step": "stepID" }. They need to be URI encoded... so something like %7B%22category%22%3A%22notebooks%22%2Cstep%3A%22notebookProfile%22%7D (I used https://www.urlencoder.org/)

@Tyriar
Copy link
Member Author

Tyriar commented Jun 20, 2022

@lramos15?

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
api feature-request Request for new features or functionality getting-started verified Verification succeeded
Projects
None yet
Development

No branches or pull requests

5 participants
@digitarald @Tyriar @JacksonKearl @karrtikr and others