Migrate the API naming guidelines into the DocC catalog - #74
Open
heckj wants to merge 6 commits into
Open
Conversation
xwu
reviewed
Mar 11, 2026
Member
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.



Summary
This is a fairly direct migration of the API naming guidelines. The first commit is explicitly the content from the swift-org-website Jekyll based markdown, then the following commits break up that code and translate the content over to DocC format. I chose, in particular, to break this up so that each guideline became it's own "article" with a number, using a prefix of "API" for the numbering scheme, so that each one - when published - is extremely easy to reference directly with a constant URI.
This PR hasn't changed any of the content - although I'd recommend making a few basic changes that align better with our general style guidelines that have evolved since this was originally written. In particular, I'd likely remove the bold in the abstracts and remove any latin abbreviations- but I wanted to set it up for review and looking prior to any additional editorial changes for better readability.
Related Issue
Closes: #44
Testing
cd api-guidelines swift package --disable-sandbox preview-documentation open http://localhost:8080/documentation/apiguidelinesBuild Verification
swift package generate-documentation --analyze --warnings-as-errorssuccessfullyswift package --disable-sandbox preview-documentationContent Review
By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.