Installing some Dash feeds results in docsets without names

zealdocs / zeal

Offline documentation browser inspired by Dash

https://zealdocs.org

GNU General Public License v3.0

11.27k stars 782 forks source link

Installing some Dash feeds results in docsets without names #514

Open k3rni opened 8 years ago

k3rni commented 8 years ago

https://gitlab.com/k3rni/pxdoc is a docset for the Phoenix Framework.

When my PR to add it to Dash was rejected, I learned that Dash already has one, but it works only with Dash's special Hexdocs support, and is thus not available for Zeal.

Currently, the CI process on gitlab builds it, and generates a zipfile with build artifacts, which in turn contains Phoenix.tgz, the proper end product.

Works fine when unpacked into Zeal's docset directory (or symlinked into, after building from source). How do I proceed with having it added? Where do I host it properly? I see #315 is still not resolved, and Zeal's documentation on that topic is rather scarce.

trollixx commented 8 years ago

You could utilise a Dash XML feed for sharing your docset, but other than that there's no way to add new docsets to Zeal.

I am currently working on adding more sources of docsets, that will allow to resolve #315.

For now maybe I should create a wiki page with a list, and point to it from the website...

k3rni commented 8 years ago

Added feed and download, hosted on free-tier Heroku: http://pxdoc.herokuapp.com/, original repo also points there. Observations:

installing via docset link works, but only via http and not https. In the latter case downloads never finish, and one needs to click Cancel or restart zeal.
installed docset has blank title, even though it's set both in meta.json and Info.plist; it unpacks itself to a blank (.docset) directory as well

How do I fix the latter? The former is probably some Heroku issue I can live with.

trollixx commented 7 years ago

I completely forgot about this one :(

If you are still interested, a quick fix would be renaming feed file to follow <Docset>.xml pattern, e.g. Phoenix.xml. Obviously Zeal should not care how the feed is named, but there's a lot yet to change to make it smart enough for that.

x-ji commented 5 years ago

@k3rni Thanks for providing the Phoenix feed, but it doesn't work anymore (HTTPError: HTTP Error 410: Gone). Guess it has something to do with Phoenix changing how their documentation is hosted?

k3rni commented 5 years ago

Haven't touched that in a long time. I think the 410 is due to the file disappearing from Heroku itself, but the docs don't build - something must have changed upstream. Will give it a shot.

malaire commented 3 years ago

Today I noticed that if I add feed using URL https://zealusercontributions.now.sh/api/docsets/Elm it's saved without name as .docset, but if I use URL https://zealusercontributions.now.sh/api/docsets/Elm.xml it's saved correctly as Elm.docset.