Add DocC documentation for swiftly #131
Merged
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
Create a plugin and tool that can generate a CLI reference for swiftly and generate the current latest document. Organize the help into a GSG (Getting Started Guide), a selection of HOWTOS, and Reference topics. Write an initial version of each. Create a Swift Package Index metadata file so that swiftly can be submitted there once the documentation is ready. Update the RELEASING.md file to check the documentation sanity and command-line reference, regenerating it if necessary.
|
@swift-server-bot test this please |
rauhul
reviewed
Jul 5, 2024
adam-fowler
reviewed
Jul 8, 2024
This one is highly specialized to suit swiftly at the moment. Perhaps it can be generalized to suit any project in the future. |
The docc plugin is being used here to generate the documentation. It appears to me that this might be the first time that someone has attempted to generate a command-line reference from the argument parser to docc. |
|
@swift-server-bot test this please |
adam-fowler
approved these changes
Jul 11, 2024
|
@swift-ci test macOS |
Co-authored-by: Adam Fowler <adamfowler71@gmail.com>
|
@swift-ci test macOS |
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 plugin and tool that can generate a CLI reference for swiftly and generate the current latest document.
Organize the help into a GSG (Getting Started Guide), a selection of HOWTOS, and Reference topics. Write an initial version of each.
Create a Swift Package Index metadata file so that swiftly can be submitted there once the documentation is ready.
Update the RELEASING.md file to check the documentation sanity and command-line reference, regenerating it if necessary.