Skip to content

Improve documentation #1588

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

Merged
merged 9 commits into from
Jun 3, 2025

Conversation

matthewbastien
Copy link
Member

Improvements to the documentation:

  • Add documentation for the Documentation Live Preview feature
  • Add folders to userdocs.docc to better structure it
  • Add links to VS Code documentation where helpful
  • Add an advanced article for installing the pre-release version of the extension
  • Refer to VS Code consistently in all articles
  • Refer to the Swift extension consistently in all articles
  • Use the Dark (Visual Studio) theme for all screenshots

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.

Great to have more detailed docs!
The installing pre-release builds I believe is covered in the contributing.md - wonder if it's worth merging these improvements to that doc and referencing it?
The gifs are amazing!!!

@matthewbastien
Copy link
Member Author

wonder if it's worth merging these improvements to that doc and referencing it?

I thought about that, but I think it's best to keep them separate. The contributing guide has more information that only contributors would need (e.g. version numbering information) while the userdocs are geared towards users of the Swift extension that probably don't care about those details.

The image is shared at least so that will be consistent between the two pages.

matthewbastien and others added 2 commits June 2, 2025 13:49
Co-authored-by: Paul LeMarquand <plemarquand@gmail.com>
Copy link
Member

@heckj heckj left a comment

Choose a reason for hiding this comment

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

Lots of smaller wording suggestions and rewrites of phrasing to either be more direct or to remove the use of passive voice, which isn't as clear in terms of "who's doing what" when describing actions.

There's numerous places where you lead with a tip, talking about how some functionality is common across all extensions that I think you should consider reworking. You generally don't want to lead with a tip right at the top of an article, and all those tips provide a link away from the content you're about to present, so it reads as though you're saying "Go read this first!". I provided a few trials of other wording, but in general, I'd remove it as a callout (something with a big box around it) and work it into the first paragraph of the overview of those pages, including the link, but more subtly - just commenting that what you're about the detail below is common infrastructure for VSCode.

There were also some images that didn't have alt-text that really should - even if simple renditions, but it'll make a HUGE difference for folks with screen readers.

Co-authored-by: Joseph Heck <j_heck@apple.com>
@matthewbastien
Copy link
Member Author

Thank you for the very thorough review @heckj!

@matthewbastien matthewbastien merged commit 8a4c5a3 into swiftlang:main Jun 3, 2025
18 checks passed
@matthewbastien matthewbastien deleted the live-preview-docs branch June 3, 2025 19:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants