RFC: Proposal to assemble collections of articles into a documentation repository

Afternoon! I wanted to provide an update on the state of the docs proposal. The proposal has been updated with changes requested by the Swift Core team, which I applied - and is available at swift-org-website/_info-architecture/0003-swift-docs-proposal.md at main · swiftlang/swift-org-website · GitHub

The changes from the earlier proposal shift a bit in terms of catalogs are included at the start, with the intention to migrate some of the articles that are currently hosted on Swift.org under /documentation/articles into DocC catalogs that will be hosted at docs.swift.org, and linked to from the Swift.org website. Each catalog is associated with an existing Swift group, and the technical reviewers for the content delegated from the associated steering group (Language, Platform, or Ecosystem).

My intention, after coming up with a reasonable repository name, is to work with the Core Team get the repo created in /swiftlang and then fill in the content with pull requests, tracking content migration and general content updates in the public, through issues on that repository (some exist today on the swift-org-website repository). The proposal includes some details about maintaining redirects from any existing articles from swift.org, and the general plan is for any legacy content to preserve older link functionality while establishing some additional organization.

This is lining up nicely with the ongoing Swift.org redesign work through the Website Workgroup, and we're aiming to integrate this new repository to host documentation content with the redesign of the Documentation section of the website.

If you have any questions, please don't hesitate to ask.

5 Likes