Skip to content

proposal to add Swift Docs repository structure #1128

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

heckj
Copy link
Member

@heckj heckj commented Aug 11, 2025

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:

  • adds the proposal with the details of the new repository, organization structure, and reviewer mechanisms to support technical accuracy vetted by people delegated from the relevant groups and teams within the Swift community.

Result:

Nothing immediately visible on the site, provides the internal proposal for future reference and implementation.

@heckj heckj self-assigned this Aug 11, 2025
@heckj heckj requested a review from a team as a code owner August 11, 2025 19:45
@heckj heckj added documentation Improvements or additions to documentation info-architecture Issues that are being considered as part of the larger information architecture design effort. labels Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation info-architecture Issues that are being considered as part of the larger information architecture design effort.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant