Update README for guiding docc location #164
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
krilnon
requested changes
Jul 26, 2023
Co-authored-by: Kyle Murray <krilnon@users.noreply.github.com>
Co-authored-by: Kyle Murray <krilnon@users.noreply.github.com>
krilnon
approved these changes
Jul 27, 2023
Frame these more as steps in the process and less as troubleshooting. Include the "Note" text at the start of the note box, as called for by editorial guidelines. Make the wording for the Swift toolchain and Xcode parallel. Match standard styling of Swift.org (upper case S).
|
I pushed a bit of a rewrite in a83f76e with some more detailed notes about the changes in that commit. Overall, I'm not entirely sure that it's the README's job to explain how to install DocC. It might be better if we can find (or write) some documentation in the DocC project about how to install and use |
amartini51
reviewed
Jul 27, 2023
Kyle-Ye
commented
Jul 27, 2023
amartini51
approved these changes
Aug 2, 2023
krilnon
approved these changes
Aug 2, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Any wording review comments are welcomed.
https://forums.swift.org/t/unable-to-build-swift-book-via-docc/66342
Fixes: #163