docs: Split ContainerBuildPlugin documentation into multiple pages#99
Merged
euanh merged 17 commits intoapple:mainfrom Apr 17, 2025
Merged
docs: Split ContainerBuildPlugin documentation into multiple pages#99euanh merged 17 commits intoapple:mainfrom
euanh merged 17 commits intoapple:mainfrom
Conversation
euanh
commented
Apr 16, 2025
Sources/SwiftContainerPluginDocumentation/Documentation.docc/ContainerImageBuilderPlugin.md
Outdated
Show resolved
Hide resolved
euanh
commented
Apr 16, 2025
euanh
commented
Apr 16, 2025
euanh
commented
Apr 16, 2025
heckj
reviewed
Apr 16, 2025
Collaborator
heckj
left a comment
There was a problem hiding this comment.
I'm not sure if the > Note: block pieces will work as I'm hoping, but I think it would sit better in that field if we can wrangle it. The rest of the updates are minor structure nits and wording choices that just tighten things up a bit.
Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/authentication.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/requirements.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/requirements.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/requirements.md
Outdated
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/requirements.md
Outdated
Show resolved
Hide resolved
heckj
reviewed
Apr 16, 2025
Sources/swift-container-plugin/Documentation.docc/Adding-the-plugin-to-your-project.md
Show resolved
Hide resolved
Sources/swift-container-plugin/Documentation.docc/Swift-Container-Plugin.md
Show resolved
Hide resolved
Co-authored-by: Joseph Heck <j_heck@apple.com>
Co-authored-by: Joseph Heck <j_heck@apple.com>
Co-authored-by: Joseph Heck <j_heck@apple.com>
Co-authored-by: Joseph Heck <j_heck@apple.com>
heckj
approved these changes
Apr 17, 2025
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
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.
Motivation
Most of the documentation explaining how a user should run the plugin is in a single DoCC file under the
ContainerImageBuilderPlugintarget (this otherwise empty target is needed because DoCC does not generate documentation for plugins).This documentation would be easier to read, and easier to expand with more information, if it was split into several sections. This would provide an outline view in the left-hand pane (the "curation") which would allow users to jump directly to sections of interest, and make internal links between documentation sections easier.
Modifications
ContainerImageBuilderPlugintoswift-container-plugin.swift-container-pluginwill hold all the high level documentation, examples and tutorials for the project. A future PR will add a manual page which specifically covers only the plugin.Result
The existing documentation is better structured. A number of small edits have been made for clarity.
Test Plan
soundnessGitHub CI job and continue to pass; all notes and usage warnings fixed.