Update DocC setup instructions #511
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
franklinsch
requested review from
binamaniar,
d-ronnqvist,
QuietMisdreavus,
ethan-kusters,
daniel-grumberg and
Kyle-Ye
franklinsch
force-pushed
the
update-documentation
branch
from
08c6d34
to
171e8db
Compare
Kyle-Ye
reviewed
Mar 18, 2023
franklinsch
force-pushed
the
update-documentation
branch
from
171e8db
to
06f1439
Compare
Kyle-Ye
approved these changes
Mar 20, 2023
d-ronnqvist
reviewed
Mar 20, 2023
README.md
Outdated
| @@ -87,7 +87,7 @@ project's technical documentation: | |||
| with support for building and viewing documentation for your framework and | |||
| its dependencies. | |||
|
|
|||
| ## Getting Started with `docc` | |||
| ## Getting Started with developing `docc` | |||
There was a problem hiding this comment.
very minor; the rest of the headers use sentence case
Suggested change
| ## Getting Started with developing `docc` | |
| ## Getting started with developing `docc` |
There was a problem hiding this comment.
Good catch, thank you!
d-ronnqvist
approved these changes
Mar 20, 2023
README.md
Outdated
| to get started with [building](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-a-specific-target), [previewing](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/previewing-documentation), | ||
| and publishing your documentation to your [website](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/generating-documentation-for-hosting-online) or [GitHub Pages](https://apple.github.io/swift-docc-plugin/documentation/swiftdoccplugin/publishing-to-github-pages). | ||
|
|
||
| ### Assembling symbol graphs and building with `docc` directly |
There was a problem hiding this comment.
I'm not sure any of this belongs in the README at this point. Maybe we should move it to the CONTRIBUTING if it's not already there?
There was a problem hiding this comment.
that's a good point. it's more of an advanced use case. I've moved it
franklinsch
force-pushed
the
update-documentation
branch
2 times, most recently
from
b2409b3
to
9354f58
Compare
Updates the instructions to get started with DocC to mention that using the Swift-DocC plugin is the preferred way of using DocC.
franklinsch
force-pushed
the
update-documentation
branch
from
9354f58
to
a5bd84e
Compare
|
@swift-ci please test |
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.
Bug/issue #, if applicable: N/A
Summary
Updates the instructions to get started with DocC to mention that using the Swift-DocC plugin is the preferred way of using DocC.
Dependencies
None.
Testing
N/A
Checklist
[ ] Added testsN/A./bin/testscript and it succeeded