Add Swift DocC documentation - #26
Open
DandyLyons wants to merge 3 commits into
Open
Conversation
Added the swift-docc-plugin package to the dependencies in Package.swift to enable documentation generation support. Updated Package.resolved to include swift-docc-plugin and swift-docc-symbolkit.
Added comprehensive DocC documentation covering: - MarkdownUtilities library API and usage patterns - md-utils CLI commands and workflows - Getting started guides for both targets - Workflow examples for Hugo, Obsidian, and general Markdown Note: This initial documentation draft was generated with Claude AI and requires human review and revision before being considered final. Co-Authored-By: Claude Sonnet 4.5 <noreply@anthropic.com>
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.
Summary
Important Note
Documentation Structure
MarkdownUtilities Library
md-utils CLI
Test plan
swift package generate-documentation🤖 Generated with Claude Code