-
Notifications
You must be signed in to change notification settings - Fork 77
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
Improve documentation #1588
Conversation
There was a problem hiding this 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!!!
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. |
userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md
Outdated
Show resolved
Hide resolved
1d32c97
to
86e1bde
Compare
userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md
Outdated
Show resolved
Hide resolved
userdocs/userdocs.docc/Articles/Features/automatic-task-creation.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Paul LeMarquand <plemarquand@gmail.com>
There was a problem hiding this 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.
userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md
Outdated
Show resolved
Hide resolved
userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md
Outdated
Show resolved
Hide resolved
userdocs/userdocs.docc/Articles/Advanced/install-pre-release.md
Outdated
Show resolved
Hide resolved
userdocs/userdocs.docc/Articles/Features/automatic-task-creation.md
Outdated
Show resolved
Hide resolved
Co-authored-by: Joseph Heck <j_heck@apple.com>
c076c80
to
4310265
Compare
Thank you for the very thorough review @heckj! |
Improvements to the documentation:
userdocs.docc
to better structure itVS Code
consistently in all articlesthe Swift extension
consistently in all articlesDark (Visual Studio)
theme for all screenshots