You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
- explicitly lists all files in /documentation from swift.org to identify a migration plan for it
- updates future directions to reflect DocC content now in the Swift GH repo for the compiler
- annotated some files within server guides that are known to be incomplete or inaccurate for removal and redirect only
- acknowledges swift/java interop as likely needing it's own location separate from Swift and C/C++ interop
- adds migration plans now that Swift also has a project-operations GH repository
Copy file name to clipboardExpand all lines: _info-architecture/0003-swift-docs-proposal.md
+70-24Lines changed: 70 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -128,7 +128,9 @@ Like the Swift Embedded examples repository, it benefits from close proximity be
128
128
129
129
### Swift Docs Repository Content
130
130
131
-
Based on my review of existing content in Swift.org, I'd propose the following initial collections to include existing articles:
131
+
Based on the existing content in Swift.org, migrate the majority of the content into DocC format, grouped into the collection sets below. A few exceptions are detailed after the file names, to accomodate very out of date content, or content that's already replicated in other locations.
132
+
133
+
All the key markdown files would remain in `/documentation` as they are today, with their front matter (Jekyll metadata) updated to redirect the URL requests to the new locations when content has been translated and accepted into the new docs repository. Markdown files prefixed with `_` are typically only included in other files and not referenced by URL, and are to be removed when the relevant content is migrated.
132
134
133
135
- API guidelines
134
136
@@ -137,37 +139,43 @@ Based on my review of existing content in Swift.org, I'd propose the following i
- documentation/source-compatibility/index.md: migrate to github.com/swiftlang/project-operations repository
228
+
(referencess to swift source compatibility project)
229
+
230
+
- documentation/source-code/index.md: migrate to github.com/swiftlang/project-operations repository
231
+
(partial list to existing source code that goes into toolchain, needs updating if kept)
232
+
233
+
- documentation/continuous-integration/index.md: migrate to github.com/swiftlang/project-operations repository
234
+
191
235
## Alternatives Considered
192
236
193
237
### Don't use DocC for cross-cutting collections
@@ -218,4 +262,6 @@ Because this content doesn't have the constraint of Swift packages, which expect
218
262
219
263
## Future Directions
220
264
221
-
I think there's a good argument for migrating some of the content in the Swift repository's [docs](https://github.com/swiftlang/swift/tree/main/docs) directory to provide details about the Swift compiler and how to use it, as well as content related to the establishment and output of both the Platform and Ecosystems steering groups.
265
+
The Swift compiler has a `userdocs` directory now, that is starting to see information specific to the compiler, and building out more detail for how the compiler works, LLDB, and the related driver pieces would be excellent additions. That's new content rather than existing migration work for the most part.
266
+
267
+
The Swift-Java interop project could easily warrant it's own docc catalog, or potentially be included in a more generic "Swift Language interop" collection. Today the majority of existing content is focused on C/C++ Interop, although that's a place where there could be significant growth.
0 commit comments