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
Copy file name to clipboardExpand all lines: _info-architecture/0003-swift-docs-proposal.md
+11-7Lines changed: 11 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -76,6 +76,7 @@ If the documentation grows to where we find ourselves wanting to host significan
76
76
The initial catalogs listed below are based on the existing content within `/documentation` at Swift.org,
77
77
but don't reflect all the possible future content we might create.
78
78
79
+
- Swift language guides - moderated/reviewed by the Language Steering Group.
79
80
- API guidelines - moderated/reviewed by the Language Steering Group.
80
81
- Server guides - moderated/reviewed by the SSWG.
81
82
- Ecosystem tools guides - moderated/reviewed by ecosystem steering group.
@@ -106,13 +107,16 @@ An example `tree` view of such a repository:
106
107
│ ├── Documentation.md
107
108
│ └── testing.md
108
109
├── swift
109
-
│ └── APIGuidelines.docc
110
-
│ ├── DocComment.md
110
+
│ ├── APIGuidelines.docc
111
+
│ │ ├── DocComment.md
112
+
│ │ ├── Documentation.md
113
+
│ │ ├── include-words-to-avoid-ambiguity.md
114
+
│ │ ├── name-according-to-roles.md
115
+
│ │ ├── omit-needless-words.md
116
+
│ │ └── weak-type-information.md
117
+
│ └── LanguageGuides.docc
111
118
│ ├── Documentation.md
112
-
│ ├── include-words-to-avoid-ambiguity.md
113
-
│ ├── name-according-to-roles.md
114
-
│ ├── omit-needless-words.md
115
-
│ └── weak-type-information.md
119
+
│ └── value-and-reference-types.md
116
120
```
117
121
118
122
The directories for each catalog residing at the root can host another DocC catalog (a directory ending with .docc), to host the markdown content in a typical DocC fashion.
@@ -193,6 +197,7 @@ Files to migrate under the `documentation` directory on Swift.org:
193
197
|[`server/guides/building.md`](https://www.swift.org/documentation/server/guides/building.html)| refine/update to provide examples of building, add section for debug vs. release and swift tooling, link to SwiftPM docs on building, add section about building in Linux using containers, add section on building with devContainers, add detail on static linux SDK, break out some content to a CI related article |
194
198
|[`server/guides/testing.md`](https://www.swift.org/documentation/server/guides/testing.html)| quite dated - update to swift 6, swift-testing, break out some content into a "CI" focused article - focus on unit testing, leave room for functional, integration testing as sep articles |
195
199
|[`articles/static-linux-getting-started.md`](https://www.swift.org/documentation/articles/static-linux-getting-started.html)| migrate as is - consider renaming or breaking into multiple, smaller focused articles, review any changes with previous authors (Alastair, Melissa) |
200
+
|[`articles/value-and-reference-types.md`](https://www.swift.org/documentation/articles/value-and-reference-types.html)| migrate content into `swift/LanguageGuides`|
196
201
|[`concurrency/index.md`](https://www.swift.org/documentation/concurrency/index.html)| redirect to content at https://www.swift.org/migration/documentation/||swift-6-concurrency-migration-guide/enabledataracesafety |
197
202
|[`articles/zero-to-swift-nvim.md`](https://www.swift.org/documentation/articles/zero-to-swift-nvim.html)| migrate into `ecosystem/EcosystemTools.docc`|
198
203
|[`articles/zero-to-swift-emacs.md`](https://www.swift.org/documentation/articles/zero-to-swift-emacs.html)| migrate into `ecosystem/EcosystemTools.docc`|
@@ -221,7 +226,6 @@ The migration process itself will be tracked by pull requests and within an issu
221
226
- documentation/core-libraries/_swift-testing.md
222
227
- documentation/core-libraries/_xctest.md
223
228
- documentation/package-manager/index.md (currently redirects to https://docs.swift.org/swiftpm/documentation/packagemanagerdocs/)
0 commit comments