[GSoC 2025] Documentation coverage

[sdms (Sofia Diniz)]

Hi, @ronnqvist!!

Thank you for your kind and detailed reply! I really appreciate the guidance.

@ronnqvist

I would also recommend playing around with the feature as it exists today to get a sense of how it behaves today and what data it output and compare that to how you'd expect it to behave and the data you'd expect it to output.

I noticed that you recently added a few new good first issues, and this one in particular caught my interest. However, it seems like someone else is already working on it, so I assume it would be best for me to explore other options.

@ronnqvist

just had a look and those issues are all still relevant. We haven't added any new good first issue items in a while but if there's any particular area of the project that you're interested in I'm sure that we can find some new good first issues in that area as well.

These pointers were really helpful—thank you. I’ve tested the feature a couple of times already and have been taking notes on thoughts on how to improve it, particularly regarding the presentation of the data. I think this will create a good foundation for the prototype that you suggested.

I’ve also been reading forum posts about this feature in order to try and better understand it. These posts in particular gave me a some valuable insights:

Experimental Documentation Coverage

Hi all, I've been playing around with the --experimental-documentation-coverage flag and it's super cool! I am, however, a bit confused by this and other "experimental" features which seems to skirt the evolution process. How do these experiments find their way into production releases and how can they be polished up and made "production ready"? Assuming that there would need to be a pitch to make this a "production" feature, is there any indication that there will be a pitch for this feature i…

Documentation Workgroup meeting notes: August 1st 2022

Attendees @daniel-grumberg @daveverwer @ethankusters @finestructure @franklin @Joseph_Heck @krilnon @Kyle-Ye @QuietMisdreavus @ronnqvist @theMomax Notes The workgroup members introduced themselves, then went over the workgroup’s goals, membership, and communication according to the charter document. Documentation workgroup meetings will occur bi-weekly on Mondays at 9am PST. The workgroup’s bi-weekly meetings will be open from now on (with the first open meeting on August 15th) and anyone c…

Additionally, I’ve been reading deeper into the codebase, and from what I gathered (please feel free to correct me if I’m mistaken), most of the implementation of the Documentation Coverage feature spans across the following files:

• Sources/SwiftDocC/Coverage/DocumentationCoverageOptions,
• Sources/SwiftDocC/Infrastructure/Context/DocumentationContext+Configuration,
• Sources/SwiftDocC/Infrastructure/CoverageDataEntry,
• Sources/SwiftDocCUtilities/Action/Actions/CoverageAction, and
• Sources/SwiftDocC/Infrastructure/ConvertActionConverter.

Finally, I took another look into the open issues in the GitHub repository and came across this one. It seems to be a relatively simple fix, and it’s closely related to the area I want to focus on, so I believe it would be a fitting first dive into the codebase.

I would greatly appreciate hearing your thoughts on these matters :)