Skip to content

Walkthrough #1709

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 10 commits into from
Aug 8, 2025
Merged

Walkthrough #1709

merged 10 commits into from
Aug 8, 2025

Conversation

rbenegal
Copy link
Contributor

@rbenegal rbenegal commented Jul 10, 2025 •
edited
Loading

Description

Add some GIFs and additional steps for running, debugging and DocC previewing to the walkthrough created by @plemarquand.

Issue: #1560

Tasks

  • Required tests have been written
  • Documentation has been updated
  • Added an entry to CHANGELOG.md if applicable

@rbenegal rbenegal marked this pull request as draft July 10, 2025 12:51
@rbenegal rbenegal marked this pull request as ready for review July 17, 2025 14:30
award999
award999 reviewed Jul 17, 2025
View reviewed changes
Copy link
Contributor

@award999 award999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions, I now realize that the buttons are provided in the package.json, not the markdown files so I see you have a lot of the buttons I was suggesting :)

Thanks for doing this, looking great

plemarquand
plemarquand reviewed Jul 17, 2025
View reviewed changes
plemarquand
plemarquand reviewed Jul 17, 2025
View reviewed changes
plemarquand
plemarquand reviewed Jul 17, 2025
View reviewed changes
award999
award999 reviewed Aug 5, 2025
View reviewed changes
Copy link
Contributor

@award999 award999 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looking good, but some suggestions

tracymiranda
tracymiranda approved these changes Aug 5, 2025
View reviewed changes
Copy link
Contributor

@tracymiranda tracymiranda left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall this is a great way to highlight some of the key functionality and include gifs that show what the expected behaviour is. These are a great set of steps to start and we can keep evolving as we add in new features or refine functionality.

plemarquand and others added 10 commits August 6, 2025 10:22
@plemarquand @rbenegal
Add an extension walkthrough
111adaf 
Adds a walkthrough to the package.json that guides users through:

- Installing Swift
- Creating a New Project
- Extension Commands
- Running Tests
- Selecting a Toolchain
@plemarquand @rbenegal
Ensure assets are added to .vsix
ace96da
@plemarquand @rbenegal
Properly theme swiftCommands.svg
bd2d8f5
@plemarquand @rbenegal
Fixup wording
4086dc2
@rbenegal
Update the walkthrough
7f7791d 
Add some GIFs and additional steps for running, debugging and DocC
previewing.

Issue: swiftlang#1560
@rbenegal
Update walkthrough based on feedback
ebac8df 
- Add additional pictures to clarify certain instructions
- Update the GIFs for testing view and DocC preview
- Ensure that each step has a unique completion action
to ensure that the checkbox is only checked after that step is viewed
@rbenegal
Simplify create project step
d9bcb8a 
Remove additional details and make the "Try it out" button launch the
swift extension create new project command directly.
@rbenegal
Update changelog
954b9ed
@rbenegal
Remove unused pictures
9665eae
@rbenegal
Incorporate suggestions from @award999
aa22d7b
@rbenegal rbenegal merged commit 048fc9a into swiftlang:main Aug 8, 2025
20 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@plemarquand plemarquand plemarquand left review comments

@award999 award999 award999 left review comments

@tracymiranda tracymiranda tracymiranda approved these changes

@adam-fowler adam-fowler Awaiting requested review from adam-fowler adam-fowler is a code owner

@0xTim 0xTim Awaiting requested review from 0xTim 0xTim is a code owner

@matthewbastien matthewbastien Awaiting requested review from matthewbastien

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@rbenegal @plemarquand @tracymiranda @award999