Add a documentation catalog.#860
Merged
twostraws merged 4 commits intotwostraws:mainfrom Jan 27, 2026
Merged
Conversation
Curated symbols. Simple oranization to match layout in Sources
Owner
|
This is an interesting idea – thank you! |
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
2 participants
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.
Add a
.docccatalog to curate the symbols for documentationIf you build the documentation for the current package, it lists all the project symbols in a single collection, and groups them by
struct,protocol,enumand so on. It's overwhelming if you're trying to navigate the project for the first time.This PR adds a documentation catalog and organizes the symbols to match the hierarchy in the Sources folder. There are no changes to the source files, and very little additional documentation added. (I added a project description just so it wasn't blank)..
You can preview these changes either with Xcode's Build Documentation command, or adding the docc package plugin to the manifest.