Hi @panaze,
thanks for your interest in the project!
Project Kickoff: Is there an existing codebase or prototype I should review, or would you recommend starting with a small proof-of-concept to explore the integration of OpenAPI documents with DocC?
Since this project would be about building a library that can ingest an OpenAPI document, and output a DocC Symbol Graph, here are two existing great libraries for working with each format:
- OpenAPI: GitHub - mattpolzin/OpenAPIKit: Codable Swift OpenAPI implementation.
- Symbol Graph: GitHub - swiftlang/swift-docc-symbolkit: A Swift package for encoding and decoding Swift Symbol Graph files.
A possible first proof of concept could just be to load a sample OpenAPI document and output one simple part of it as DocC Symbol Graph. You could use your favorite HTTP API as an example here.
Getting Started: Which aspect of the project should I focus on initially—parsing the OpenAPI documents or developing the documentation generation mechanism?
Since both formats already have libraries, the value-add of this new project is to translate one into the other. In a similar way that Swift OpenAPI Generator translates OpenAPI documents into Swift code (rather than DocC documentation). Swift OpenAPI Generator also uses OpenAPIKit, by the way.
First Steps: Are there any "good first issues" or specific tasks that would help me get acquainted with the codebase and project workflow?
I think familiarizing yourself with both libraries and trying to use them on simple documents would be a great start here!
@sofiaromorales @beaumont please fill in anything I missed 