swift-doc icon indicating copy to clipboard operation
swift-doc copied to clipboard

DocSet Output

Open mattt opened this issue 4 years ago • 8 comments

For Dash, and other clients.

mattt avatar Apr 01 '20 17:04 mattt

To generate the database, I have a strong preference for using @stephencelis's SQLite.swift library.

mattt avatar Apr 02 '20 13:04 mattt

Also, FWIW: I recently discovered Apple's docsetutil command, and am hosting a mirror of the project here (it was removed in Xcode 9.3). Unfortunately, it's unclear how Apple's .docset bundles relate to Dash's (only a few of the ones I tried from the latter validate with docsetutil), and there's no clear specification for what a DocSet bundle actually is.

mattt avatar Apr 02 '20 13:04 mattt

I guess, you are already aware of Dash-User-Contributions:Swift. If not, It might be somewhat helpful to bring the standard lib docs into Dash.

lucendio avatar Jul 19 '20 17:07 lucendio

@lucendio Indeed I am. I believe Dash is ingesting swiftdoc.org as its primary data source for Swift standard library documentation.

mattt avatar Jul 20 '20 12:07 mattt

Not really, I think, or maybe it just used to. Examples:

  • can't find the String type in Dash
  • Strings and Characters does not exist in swiftdoc.org and from Dash that page links to a 404

Did swiftdoc.org derive from docs.swift.org? (I'm new to the community)

lucendio avatar Jul 20 '20 15:07 lucendio

Not really, I think, or maybe it just used to.

Ah, my mistake. That's a recent change on the part of Dash.

Did swiftdoc.org derive from docs.swift.org? (I'm new to the community)

No, these are separate projects (although Nate and I have worked on both).

mattt avatar Jul 20 '20 15:07 mattt

Any updates on this?

Sam-Spencer avatar May 26 '21 16:05 Sam-Spencer

@Sam-Spencer I was planning to ship this sooner, but #104 got away from me, and I ended up having to scrap that work. Right now, my goal is to cut a 1.0.0 release with what we have now and look at DocSet support for the next minor release (1.1.0).

mattt avatar Jun 01 '21 17:06 mattt