Interested in DocC Language Features in SourceKit-LSP

Development GSoC
1

Greetings! My name is Roshan Gomes, and I am a Pre-Final Year Computer Science Graduate. I have a strong passion for artificial intelligence, machine learning, and full-stack development. Among the various projects I have undertaken, iOS development is particularly significant to me. I am honored to be a winner of the Swift Student Challenge, which has further ignited my enthusiasm for contributing to the Swift ecosystem and the open-source community.

My journey in iOS development began with Dazzle, an AI-driven fashion platform. Additionally, I have created Sentimently, a sentiment analysis application, and Petify, an e-commerce site for pet adoption. At this stage, I am eager to expand my horizons beyond app development and delve into Swift’s tooling and infrastructure through open-source contributions.

Here are some relevant experiences that I bring to this project:

  • I have utilized SwiftUI, Core ML, and Core Data in the development of iOS applications.

  • I possess experience in crafting technical documentation for my projects.

  • I enjoy collaborative development; I have worked on several projects within teams and have participated in hackathons.

This year, I am keen to make meaningful contributions to open source, explore Swift’s developer tools, and engage with the Swift community. I would greatly appreciate any guidance on how to initiate my involvement in this project! I look forward to learning and collaborating.

@ahoppen and @matthewbastien– Any advice on how to get started would be greatly appreciated!

2

Hello @roshangomes and thank you for your interest in the DocC Language Features!

Right now, only a basic Live Preview is supported in SourceKit-LSP which you can try out within VS Code. You'll need to grab one of the latest nightly toolchain builds to give it a test run. You can run the VS Code command Swift: Preview Documentation while a Swift file is open to show the live preview editor.

A test project like SlothCreator is good to start with for seeing what's available.

We'd like to extend SwiftDocC support in SourceKit-LSP by providing:

  • Warning diagnostics when a reference resolves to multiple symbols and needs to be disambiguated.
  • Error diagnostics when a reference cannot be resolved to any symbol.
  • Go to definition on references.
  • Syntax highlighting in Markdown and Tutorial files.

References in SwiftDocC documentation are surrounded by double backticks in Swift documentation comments and in Markdown and Tutorial files.

If you have any questions then feel free to continue the conversation here and I'll try to answer them!

1 Like