Skip to content

Commit 6f3841e

Browse files
committed
adding in Swift Language Guides section and archive
1 parent 6f27497 commit 6f3841e

File tree

1 file changed

+11
-7
lines changed

1 file changed

+11
-7
lines changed

_info-architecture/0003-swift-docs-proposal.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ If the documentation grows to where we find ourselves wanting to host significan
7676
The initial catalogs listed below are based on the existing content within `/documentation` at Swift.org,
7777
but don't reflect all the possible future content we might create.
7878

79+
- Swift language guides - moderated/reviewed by the Language Steering Group.
7980
- API guidelines - moderated/reviewed by the Language Steering Group.
8081
- Server guides - moderated/reviewed by the SSWG.
8182
- Ecosystem tools guides - moderated/reviewed by ecosystem steering group.
@@ -106,13 +107,16 @@ An example `tree` view of such a repository:
106107
│   ├── Documentation.md
107108
│   └── testing.md
108109
├── 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
111118
│   ├── 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
116120
```
117121

118122
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:
193197
| [`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 |
194198
| [`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 |
195199
| [`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`|
196201
| [`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 |
197202
| [`articles/zero-to-swift-nvim.md`](https://www.swift.org/documentation/articles/zero-to-swift-nvim.html) | migrate into `ecosystem/EcosystemTools.docc` |
198203
| [`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
221226
- documentation/core-libraries/_swift-testing.md
222227
- documentation/core-libraries/_xctest.md
223228
- documentation/package-manager/index.md (currently redirects to https://docs.swift.org/swiftpm/documentation/packagemanagerdocs/)
224-
- documentation/articles/value-and-reference-types.md
225229
- documentation/tspl/index.md
226230
- documentation/lldb/index.md
227231
- documentation/lldb/_playground-support.md

0 commit comments

Comments
 (0)