Add a documentation catalog to PackagePlugin. #8392
Draft
Conversation
This file contains hidden or 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
Member
| Thank you so much for doing this! Could we remove the stale documentation in this PR too? |
Contributor
| Thanks, Graham, this looks great! |
Contributor
Can you clarify where you're referring to? |
| Use `PackagePlugin` to create plugins that extend Swift package manager's behavior in one of two ways: | ||
| | ||
| * term Build-tool plugins: Create a command that Swift package manager runs either as a pre-build step before it performs a build action, or as a specific step in a target's build process. | ||
| * term Command plugins: Create a command that someone runs either by passing its name as an argument to the `swift package` command-line tool, or from UI their developer environment. |
Contributor
There was a problem hiding this comment.
grammar: "from UI in their developer environment" ?
Member
| I was referring to the content here: https://github.com/swiftlang/swift-package-manager/blob/main/Documentation/Plugins.md |
iamleeg force-pushed the iamleeg/package-description-docc-catalog branch from c14bfb5 to 89a4648 Compare 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.
Create a documentation catalog for PackagePlugin and improve the documentation experience in swift-docc.
Motivation:
PackagePlugin has great API documentation in swift-docc comments and the overview in
Documentation/Plugins.mdis very helpful, it would be better if these were associated together in a swift-docc documentation catalog so folks can render a combined view of the documentation with hyperlinks to the types and methods that they use.Modifications:
In this draft:
Planned for the PR:
Result:
People who use swift-docc can view integrated documentation for PackagePlugin. Particularly, people who use Xcode can use Product > Build Documentation and view the docs in the Xcode documentation window.