Skip to content

Commit 59201ad

Browse files
committed
tweaks
1 parent c46e0b1 commit 59201ad

File tree

1 file changed

+29
-30
lines changed

1 file changed

+29
-30
lines changed

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

Lines changed: 29 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -169,17 +169,17 @@ Based on the existing content in Swift.org, the general goal is to migrate the m
169169
All of the listed markdown files would remain in `/documentation`, with their front matter (Jekyll metadata) updated to redirect the URL requests to the new locations as content is migrated and accepted into the new docs repository.
170170
Markdown files prefixed with `_` are typically only included in other files and not referenced by URL, and can be removed after they are migrated.
171171

172-
## Migration Plan for files under `documentation`
172+
## Migration Plan
173173

174-
A few exceptions are detailed after the file names, to accommodate very out-of-date content, or content that's already replicated in other locations.
175-
176-
This proposal is primarily meant to provide a guide to the structure for content as we want to see it,
177-
and isn't meant to provide a full and discrete audit of all existing content.
178-
Nevertheless, a few examples stand out and have been discussed previously within the community as needing updates, or removal and relevant links redirected to more up-to-date and recent content.
174+
This proposal is primarily meant to provide a guide to the structure for content as we want to see it.
175+
In the process of establishing this new repository and structure of DocC catalogs, the following files from swift.org are intended to be migrated.
179176
A full audit of the documentation for recency and relevancy is worthwhile, but beyond the scope of this proposal.
180177

181-
The notes of this migration are intended to be guides, and any migration process isn't expected to be done immediately and in one sweep.
178+
This list is intended to be a guide, with additional potential updates from the relevant reviewing team, and is not expected to be complete in a single sweep.
182179
The migration can, and should, occur incrementally, building into the docs repository as supported by the community including content reviewers and their availability.
180+
The migration process itself will be tracked by pull requests and within an issue or issues housed at https://github.com/swiftlang/swift-org-website/, with the issues and tracking to be started if the proposal is approved.
181+
182+
Files under the `documentation` directory on Swift.org:
183183

184184
| `source` | status & destination |
185185
| - | - |
@@ -224,29 +224,28 @@ The migration can, and should, occur incrementally, building into the docs repos
224224
| [`source-compatibility/index.md`](https://www.swift.org/documentation/source-compatibility/index.html) | migrate to [project-operations](https://github.com/swiftlang/project-operations) repository (referencess to swift source compatibility project) |
225225
| [`source-code/index.md`](https://www.swift.org/documentation/source-code/index.html) | migrate to [project-operations](https://github.com/swiftlang/project-operations) repository (partial list to existing source code that goes into toolchain, needs updating if kept) |
226226

227-
### Swift.org documentation files & directories remaining:
228-
229-
- Remain on swift.org
230-
- documentation/cxx-interop/index.md (Doug Gregor has indicated a desire to reset and migrate this content into the Swift repository)
231-
- documentation/cxx-interop/safe-interop/index.md
232-
- documentation/cxx-interop/project-build-setup/index.md
233-
- documentation/cxx-interop/status/index.md
234-
- documentation/articles/wrapping-c-cpp-library-in-swift.md
235-
- documentation/core-libraries/index.md
236-
- documentation/core-libraries/_foundation.md
237-
- documentation/core-libraries/_libdispatch.md
238-
- documentation/core-libraries/_swift-testing.md
239-
- documentation/core-libraries/_xctest.md
240-
- documentation/package-manager/index.md (currently redirects to https://docs.swift.org/swiftpm/documentation/packagemanagerdocs/)
241-
- documentation/articles/value-and-reference-types.md
242-
- documentation/tspl/index.md
243-
- documentation/lldb/index.md
244-
- documentation/lldb/_playground-support.md
245-
- documentation/swift-compiler/index.md
246-
- documentation/swift-compiler/_compiler-architecture.md
247-
- documentation/standard-library/index.md
248-
- documentation/standard-library/_preview-package.md
249-
- documentation/standard-library/_stdlib-design.md
227+
### Swift.org documentation remaining and untouched:
228+
229+
- documentation/cxx-interop/index.md (Doug Gregor indicated a desire to reset and migrate this content into the Swift repository in the future)
230+
- documentation/cxx-interop/safe-interop/index.md
231+
- documentation/cxx-interop/project-build-setup/index.md
232+
- documentation/cxx-interop/status/index.md
233+
- documentation/articles/wrapping-c-cpp-library-in-swift.md
234+
- documentation/core-libraries/index.md
235+
- documentation/core-libraries/_foundation.md
236+
- documentation/core-libraries/_libdispatch.md
237+
- documentation/core-libraries/_swift-testing.md
238+
- documentation/core-libraries/_xctest.md
239+
- documentation/package-manager/index.md (currently redirects to https://docs.swift.org/swiftpm/documentation/packagemanagerdocs/)
240+
- documentation/articles/value-and-reference-types.md
241+
- documentation/tspl/index.md
242+
- documentation/lldb/index.md
243+
- documentation/lldb/_playground-support.md
244+
- documentation/swift-compiler/index.md
245+
- documentation/swift-compiler/_compiler-architecture.md
246+
- documentation/standard-library/index.md
247+
- documentation/standard-library/_preview-package.md
248+
- documentation/standard-library/_stdlib-design.md
250249

251250
## Alternatives Considered
252251

0 commit comments

Comments
 (0)