Thank you for your interest in this project!
To get started I would love to know any specific guidance from the mentors on the parts of the DocC codebases
You might want to check out these formats since you'll be working with them on this project:
- 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.
I also recommend checking the DocC codebase to get an idea on how the DocC compiler works and how it uses the input data to produce documentation.
I should explore first so that I maybe try to build an implementation which I can propose ? Do I need to propose a demo around that to check I am thinking in the right direction ?
You don’t need to build a fully functional demo, but I recommend you to either create a small proof of concept or spend some time getting familiar with these technologies, one way of doing this it's by looking at good first issues in any of the repos.
If you'd like to give developing a working proof of concept a try, as @Honza_Dvorsky mentioned here, a great place to start could be translating a simple OpenAPI document into a Symbol Graph.
Like do we need to build a separate tool , or maybe we can implement parsers inside the main project ?
We're thinking of this as a standalone tool that can later be used as a dependency in projects like the Swift OpenAPI Generator or in VSCode plugins. It could make use of the technologies listed above to help translate between OpenAPI docs to SymbolGraphFiles (SGFs).
@Honza_Dvorsky, @beaumont, and I are really looking forward to seeing what you come up with! Feel free to share your ideas as you go, we’re here to give feedback and help you refine your proposal :)