apple / apple/swift-openapi-generator

Use Swift Snippets for compilable sample code embedded in docs

Open
#8 0 comments 0 reactions 0 assignees View on GitHub
area/documentation kind/enhancement size/M
Dominant language
Swift
Stars
2k
Forks
182
Avg merge
13h 28m
Merged PRs (30d)
5

Description

We should explore [Swift Snippets](https://github.com/apple/swift-evolution/blob/main/proposals/0356-swift-snippets.md) for our documentation, to ensure they continue to compile successfully even as we evolve the API.

Today, we have to update the snippets in docs manually, and thus they can get out of sync.

Contributor guide

Open the contributing guide

Research direction

Start by reading the linked Swift Snippets proposal and reviewing the repository's documentation snippets. The issue names no files or tests; done means establishing a Swift Snippets-based approach that keeps embedded sample code compiling as the API evolves.

Written by the indexing model from the issue text.

Assessment

Tech stack
swift
Domain
documentation
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
30/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.