Swift Documentation question


(Jon Hoffman) #1

Hello,
I have been looking for a certain type of documentation for the Swift Standard Library. I know we have this page: https://developer.apple.com/documentation/swift but what I am looking for is something that lists the various protocols and types that make up the standard library with links to the reference pages for the types and protocols. Does documentation like this exist? I thought I have seen this documentation before but for the life of me I have not been able to find it.

Thanks,

Jon


(Marco S Hyman) #2

but what I am looking for is something that lists the various protocols and types that make up the standard library with links to the reference pages for the types and protocols. Does documentation like this exist? I thought I have seen this documentation before but for the life of me I have not been able to find it.

http://swiftdoc.org


(Jon Shier) #3

swiftdoc.org <http://swiftdoc.org/> should be integrated into swift.org <http://swift.org/> and be kept officially up to date. Unfortunately it doesn’t have Swift 4 coverage yet, which is a shame, as I like that documentation format more than Apple’s official one.

Jon

···

On Jul 1, 2017, at 12:04 PM, Marco S Hyman via swift-users <swift-users@swift.org> wrote:

but what I am looking for is something that lists the various protocols and types that make up the standard library with links to the reference pages for the types and protocols. Does documentation like this exist? I thought I have seen this documentation before but for the life of me I have not been able to find it.

http://swiftdoc.org

_______________________________________________
swift-users mailing list
swift-users@swift.org
https://lists.swift.org/mailman/listinfo/swift-users


(^) #4

i agree. it would also be a lot better if the docs lived on the actual swift website instead of the apple website.

···

On Jul 1, 2017, at 4:36 PM, Jon Shier via swift-users <swift-users@swift.org> wrote:

  swiftdoc.org should be integrated into swift.org and be kept officially up to date. Unfortunately it doesn’t have Swift 4 coverage yet, which is a shame, as I like that documentation format more than Apple’s official one.

Jon

On Jul 1, 2017, at 12:04 PM, Marco S Hyman via swift-users <swift-users@swift.org> wrote:

but what I am looking for is something that lists the various protocols and types that make up the standard library with links to the reference pages for the types and protocols. Does documentation like this exist? I thought I have seen this documentation before but for the life of me I have not been able to find it.

http://swiftdoc.org

_______________________________________________
swift-users mailing list
swift-users@swift.org
https://lists.swift.org/mailman/listinfo/swift-users

_______________________________________________
swift-users mailing list
swift-users@swift.org
https://lists.swift.org/mailman/listinfo/swift-users


#5

swiftdoc.org should be integrated into swift.org and be kept officially
up to date.

I agree.

Unfortunately it doesn’t have Swift 4 coverage yet, which is a shame, as I

like that documentation format more than Apple’s official one.

Well, it does have an option for the nightly build of the master branch
<http://swiftdoc.org/nightly/>, so that is something.

On a tangential note, I really like SwiftDoc’s visual hierarchy displays
(eg. this
<http://swiftdoc.org/nightly/protocol/ExpressibleByIntegerLiteral/hierarchy/>),
though for some (eg. this
<http://swiftdoc.org/nightly/protocol/Equatable/hierarchy/>) it would be
nice to have an option to hide the concrete types and only show protocols.

Nevin

···

On Sat, Jul 1, 2017 at 4:36 PM, Jon Shier via swift-users < swift-users@swift.org> wrote: