1

Meeting notes

  • Mishal
    • Follow-up in a couple of weeks to get updates on the workgroup's goals for 2024 update
  • Areas to highlight:
    • Links improvements
      • Dianna: Proposal to support vector links, disambiguation
      • David: Linking between modules, support for linking to headings
        • 2 feature flags
        • SwiftPM plugin integration
    • Vera: Overloads
      • Simplifies navigation
    • Better support for C/ObjC interop documentation
    • C++ support
    • Don’t show typed throws documentation
    • Better warnings when documentation doesn’t match parameters
    • SPI
      • Behind the scenes improvements
      • Consistent release URL for the current release. Old versions will still be hosted
    • Joannis:
      • Working on Swift on server blog
      • Difficult to determine what the correct URL to link to for overloads
      • DocC overloads feature will make this easier
    • TSPL:
      • Documentation for Swift 6
      • Improving concurrency-related topics
    • David:
      • Cross-module linking, readability of links, combined hosting
      • Combined documentation will require SwiftPM work
  • Joannis:
    • Guidelines on what makes “good” documentation?
      • There are WWDC sessions breaking down your frameworks in areas
      • Dianna: similar API Design guidelines
        • When documentation has lots of warning blocks
      • Kyle: not sure guidelines will help make people care about writing docs
      • Joannis: Still helpful to provide resources for those who care
      • Dianna: Quality is more important than quantity
      • Vera: something to be said of a culture of documentation
        • Important to make it easy to view documentation
        • Joannis: Documentation is key for SSWG
1 Like