proposal to add Swift Docs repository structure #1128
+221
−0
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Adds a proposal that outlines collecting and organizing sets of documentation into a single repository, migrating content from the /articles directory of swift.org into these new collections, and presenting them back through to the website using DocC archives, hosted similarly to a number of other projects.
Motivation:
The documentation for Swift has grown organically since its open source release. That growth has resulted in fragmented locations to find information, little organization, and inconsistencies in updating content as the language grew. The Swift WebSite workgroup started down the path to redesign the swift.org website, and parallel with launched the Swift Information Architecture project, to both revitalize the site and to set a structure that supports further, consistent growth for Swift documentation.
Modifications:
Result:
Nothing immediately visible on the site, provides the internal proposal for future reference and implementation.