Documentation Workgroup meeting: October 23rd, 2023

The Documentation Workgroup will be holding its next meeting on Monday, October 23rd, 2023 from 8:30am to 9:30am PT (or see the time in your own timezone).

This meeting will be open to anyone who wishes to contribute. If you wish to participate, please reach out to @swift-documentation-workgroup in forums via DM for a link to the WebEx meeting.

Meeting notes for this meeting will posted in this thread shortly after.


Please propose any additional agenda items in this thread.

Support for another output type such as static html files

Hi Genaro, there's been work to make archives hostable using default web server configurations: Supporting hosting DocC archives in static environments (like GitHub Pages) by default. If you'd like to discuss further output file formats, I'd recommend starting a discussion in Swift-DocC - Swift Forums.

Thank you!

1 Like

Meeting notes

  • Sofía opened Content changes to the DocCDocumentation Catalog by sofiaromorales · Pull Request #742 · apple/swift-docc · GitHub with improvements to DocC documentation.
  • Regarding the overloads proposal:
    • Joe: Adds a bit of complication to get an overview of what symbols need to be documented.
    • Daniel: Might be a few rough edges with search—do search results show overloads?
    • Kelvin: How do we define what an overload is?
    • Kyle Murray: If DocC adds a disambiguating hash, we create an overloads page. You'd still be able to use the precise disambiguation hash.
    • Alex Martini: From the language perspective, two methods are overloads if they have the same name and labels.
    • Kelvin: How about are instance vs. static methods of the same name?
    • Daniel: In the proposal, they're not captured as overloads.
    • Alex: I wouldn't consider those as overloads.
    • Kelvin: What about async?
    • Alex: Need to check whether you can overload something on async.
    • Kelvin: Yes, you can overload on async.