Repository navigation
Add DocC catalog, docs verification workflow, and editor support docs #3
Description
Summary
Add first-class package documentation and tooling support on top of the existing markdown docs and Quick Help comments.
Scope
- Add a
SimpleChart.docccatalog with a landing page and focused articles for getting started and interactive chart APIs. - Polish high-value Quick Help for the interaction/navigation surface so Xcode symbol docs are more teachable.
- Add a GitHub Actions workflow that verifies documentation builds cleanly.
- Add an editor-support note covering Xcode and sourcekit-lsp usage for the SwiftPM package.
Acceptance criteria
- The repo contains a DocC catalog under the
SimpleCharttarget. - README/docs link users toward the new IDE-native docs and editor support note.
- CI verifies the documentation build path.
- Local task artifacts and issue progress are updated with the final verification results.
Metadata
Metadata
Assignees
Labels
No labels
Activity
andywkff commentedon Apr 15, 2026
Completed the docs/tooling slice for IDE-native package documentation.
Shipped:
SimpleChart.docccatalog with landing and focused articles for getting started, wrapper selection, interactive charts, and legacy migration.docs/editor-support.mdcovering Xcode Quick Help, local DocC rendering, andsourcekit-lspexpectations.SCChartTimeViewport,SCChartScrollBehavior,SCChartZoomBehavior,SCChartGestureConfiguration, and the scrollable wrappers.Documentationworkflow that runsxcodebuild docbuildfor the SwiftPM scheme on macOS.Verification:
swift buildswift testxcodebuild docbuild -scheme SimpleChart -destination 'platform=macOS' -derivedDataPath .build/DerivedData CODE_SIGNING_ALLOWED=NOResult: package build passed, all 73 tests passed, and the DocC build succeeded.