Documentation Workgroup meeting: March 13th, 2023

Swift Documentation Workgroup Updates
1

The Documentation Workgroup will be holding its next meeting on Monday, March 13th, 2023 from 8:30am to 9:30am PT. Note that the meeting will occur during a period where some time zones will have switched to summer time but not others, so I'd recommend checking Event Time Announcer - Documentation Workgroup meeting to convert the time to your local time zone.

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.

Agenda

  • Documentation workgroup overlap with SSWG blog post update (@daveverwer)
  • DocC-based TSPL is live! (@Alex_Martini, @krilnon)
  • Continued discussion on facilitating documentation tooling setup

Please propose any additional agenda items in this thread.

3 Likes
2

I would like to talk about involvement in GSoC if there is time

3

Meeting Notes

Attendees

Notes

  • Dave (SSWG blog post)
    • SSWG is preparing a 5.8 blog post. Group will mention:
      • Quick Navigation
      • Customisation options (have docs to link for that)
      • Sofía: DocC render customisation of theme
      • Extensions (will prepare docs)
      • TSPL is OSS
      • Joe: Snippets docs?
      • Joe/Kelvin: @_documentation crashes VSCode
      • Dave: Dave to let the workgroup know the deadline for the post
      • Dave to prepare a draft
      • Sven: Passthrough build options for SPI needs implementation
  • KyleM: TSPL went live fully DocC based
    • #1 request is that they want dark mode toggle which was gone because opted into custom footer, fixed
    • Working on finer-grained redirects for on-page sections
    • A couple of community PRs for content changes
    • KyleM: mentions of Concurrency documentation in Forums. Considering TSPL into Swift Evolution. Maybe process document could help.
    • Sofía: Add GitHub button at the bottom of documentation page?
  • Daniel (GSoC):
    • Good opportunity for getting contributors
    • KyleM: Will think about TSPL projects, content and processes.
    • Daniel: Maybe tested code listings?
    • Daniel: Mentoring on LLVM, can co-mentor a Swift project.
    • Franklin: Maybe supporting tags/keywords to filter in Quick Navigation?
    • Daniel: Snippets in CI?
    • Kyle Ye: Swift-based generation?
    • David: ePub rendering?
      • Sofía: Seen that as a request for TSPL on forums
      • Victoria: Might be more straightforward than server-based rendering, because converting from HTML?
      • Daniel: Seems doable.
    • Franklin: Maybe integrating LSP / DocC
    • Victoria: SourceKit-LSP / DocC integration is the main piece
    • Victoria: More complicated than rust because of documentation extensions
    • Franklin: One-click building of docs
    • Daniel: 20th of March: students start submitting, 4th of April is deadline for submitting.
    • Sofía: Last year there was a DocC project about diffing, maybe should bring it back up.
    • Kelvin: Feels complex. Need to be aware of SwiftPM manifest versions.
1 Like