Documentation Workgroup meeting: June 2nd, 2025

Documentation Workgroup Meeting - 2 Jun 2025

hackmd notes: https://hackmd.io/@kTmq8wwxT-S7kpJjg_Bevg/HJ_S54oMex/edit

Attendees:

  • Franklin Schrans
  • Joe Heck
  • Sven Schmidt
  • David Ronnqvist
  • Rauhul Varma
  • Vera Mitchell
  • Sofia Rodriquez Morales

Discussion:

Embedded Swift

Bare DocC catalog for Swift Embedded Examples

Rauhul - just embedded in Package to get previews operational.

Moving docs to get set up for hosting with Swift.org

  • not supported configuration

Integration Tests

Integration in the docc-renderer repo, in docc?
Likely including it in one of the repositories makes the most sense.

No significant preference, and choice of where this lands can wait until after any proof of concept exists.

Maybe use SlothCreator as a sample set

Brittle vs. Not - snapshots? Pointfree uses it, as does SPI. Not looking for that level of regression analysis for this testing scenario. Don't want to be impacted by design changes.

Generally sounds great, provides a super-high level acceptance test like setup.

We'll want to be careful about putting anything line for toolchain submissions - needs lots of permissions and has to be incredibly stable.

There's a distant possibility of wiring something like this into /bin/test - which is used for toolchain submissions for a full acceptance test.

Action Items

  • Joe to ask Mishal for GH action enable on the various DocC repositories.