Skip to content
This repository has been archived by the owner on Jun 1, 2023. It is now read-only.

DocSet Output #27

Open
mattt opened this issue Apr 1, 2020 · 8 comments
Open

DocSet Output #27

mattt opened this issue Apr 1, 2020 · 8 comments
Labels
enhancement New feature or request
Projects
Milestone

Comments

@mattt
Copy link
Contributor

mattt commented Apr 1, 2020

For Dash, and other clients.

@mattt mattt added the enhancement New feature or request label Apr 1, 2020
@mattt mattt added this to To do in SwiftDoc Apr 2, 2020
@mattt
Copy link
Contributor Author

mattt commented Apr 2, 2020

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

@mattt
Copy link
Contributor Author

mattt commented Apr 2, 2020

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 mattt moved this from To do to In progress in SwiftDoc May 5, 2020
@lucendio
Copy link

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.

@mattt
Copy link
Contributor Author

mattt commented Jul 20, 2020

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

@lucendio
Copy link

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)

@mattt
Copy link
Contributor Author

mattt commented Jul 20, 2020

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 mattt added this to the 1.0.0-beta.5 milestone Jul 31, 2020
@mattt mattt modified the milestones: 1.0.0-beta.5, 1.0.0-beta.6 Sep 25, 2020
@mattt mattt modified the milestones: 1.0.0-beta.6, 1.1.0 Mar 26, 2021
@Sam-Spencer
Copy link

Any updates on this?

@mattt
Copy link
Contributor Author

mattt commented Jun 1, 2021

@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).

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
enhancement New feature or request
Projects
SwiftDoc
  
In progress
Development

Successfully merging a pull request may close this issue.

3 participants