Skip to content

Add a "Getting Started" Experience for vscode-powershell #3414

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

Closed
JustinGrote opened this issue Jun 15, 2021 · 3 comments
Closed

Add a "Getting Started" Experience for vscode-powershell #3414

JustinGrote opened this issue Jun 15, 2021 · 3 comments
Labels
Area-Documentation Issue-Enhancement A feature request (enhancement). Resolution-Duplicate Will close automatically. Up for Grabs Will shepherd PRs.

Comments

@JustinGrote
Copy link
Collaborator

JustinGrote commented Jun 15, 2021

Summary of the new feature
The new getting started experience lets extension authors contribute tour walkthroughs of their extension.
https://code.visualstudio.com/updates/v1_57#_new-getting-started-experience

Proposed technical implementation details (optional)

VSCode-Powershell would be a good candidate, and this would be a good up-for-grabs item for a community member to develop, maybe using the existing documentation as a base. Extracting the luna paint extension .vsix into a zip, you can see the "Getting Started" is just a sequence of markdown files and an addition to the contributes section of the package.json.

		"walkthroughs": [
			{
				"id": "exampleProject",
				"title": "Edit Images With Luna Paint",
				"description": "Everything you need to get started editing images inside VS Code",
				"steps": [
					{
						"id": "luna.interfaceOverview",
						"title": "Interface Overview",
						"description": "Luna Paint features a canvas, several windows and bars on the top and bottom.",
						"media": {
							"image": "getting-started/images/1-interface-overview.png",
							"altText": ""
						}
					},
					{
						"id": "luna.pencilTool",
						"title": "Pencil Tool",
						"description": "",
						"media": {
							"markdown": "getting-started/2-pencil-tool.md"
						}
					},
					{
						"id": "luna.selectionTools",
						"title": "Selection Tools",
						"description": "",
						"media": {
							"markdown": "getting-started/3-selection-tools.md"
						}
					},
					{
						"id": "luna.cropTool",
						"title": "Crop Tool",
						"description": "",
						"media": {
							"markdown": "getting-started/4-crop-tool.md"
						}
					},
					{
						"id": "luna.lineTool",
						"title": "Line Tool",
						"description": "",
						"media": {
							"markdown": "getting-started/5-line-tool.md"
						}
					},
					{
						"id": "luna.colorPickerTool",
						"title": "Color Picker Tool",
						"description": "",
						"media": {
							"markdown": "getting-started/6-color-picker-tool.md"
						}
					},
					{
						"id": "luna.rectangleTool",
						"title": "Rectangle Tool",
						"description": "",
						"media": {
							"markdown": "getting-started/7-rectangle-tool.md"
						}
					},
					{
						"id": "luna.viewportTools",
						"title": "Viewport Tools",
						"description": "",
						"media": {
							"markdown": "getting-started/8-viewport-tools.md"
						}
					}
				]
			}
@ghost ghost added the Needs: Triage Maintainer attention needed! label Jun 15, 2021
@andyleejordan
Copy link
Member

Hey, I think this would be really cool. Our documentation in general needs a major revamp. While this would take a fair bit of shepherding and then maintenance work once we have it, I think I'm willing to see that through. @SydneyhSmith and @rjmholt should we start a whole "documentation" project? I need to get the docfx site back up, write releasing docs, write an architecture doc...so much to do.

@andyleejordan andyleejordan added Area-Documentation Issue-Enhancement A feature request (enhancement). Up for Grabs Will shepherd PRs. and removed Needs: Triage Maintainer attention needed! labels Jun 16, 2021
@andyleejordan
Copy link
Member

@JustinGrote Since I'm marking this duplicate even though it was the first filed, just so we have one issue front and center.

@andyleejordan andyleejordan added the Resolution-Duplicate Will close automatically. label Oct 28, 2021
@ghost
Copy link

ghost commented Nov 3, 2021

This issue has been marked as duplicate and has not had any activity in a day. It has been closed for housekeeping purposes.

@ghost ghost closed this as completed Nov 3, 2021
This issue was closed.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Area-Documentation Issue-Enhancement A feature request (enhancement). Resolution-Duplicate Will close automatically. Up for Grabs Will shepherd PRs.
Projects
None yet
Development

No branches or pull requests

2 participants