Add documentation #35
Merged
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.
Description
This PR introduces comprehensive documentation for the FirebladeMath library using Swift-DocC. It encompasses setting up the documentation generation infrastructure, adding a new GitHub Actions workflow for automated documentation building and deployment, and adding inline documentation comments to the public API.
Changes
swift-docc-plugindependency toPackage.swift.Makefilewith targets for generating, previewing, and checking documentation coverage and links (docs,docs-preview,docs-generate,docs-check-coverage,docs-check-links)..github/workflows/docs.ymlto automatically build and deploy documentation to GitHub Pages on push tomain/masterbranches.///) to public functions, structs, and extensions across the codebase, including:Motivation
To improve the usability and discoverability of the library's features for developers, ensuring that all public APIs are well-documented and accessible via a hosted documentation site.