Zeal/Dash/Velocity docs


photo

Recommended Posts

I'd love to see docs in Zeal/Velocity. I guess Dash doesn't make much sense but that's the standard so it'll appear in the others once added to Dash.

Edited by Phil_T
Link to post

Phil_T

Thanks for the suggestion. We currently have no plans to switch to different offline docs publishing scheme, but maybe useful in the future.

Right now we do provide only CHM-based offline documentation (you can download it in SDK Browser in the Knowledge -> Offline Docs section):

image.png

Thanks!

How to submit a good bug report
---
FTP server for test scenes and user uploads:

Link to post

Thanks, yeah I've got the CHM.

Using the Dash format is not exclusive of other formats. Dash format allows developers to use the same doc app for all documentation, e.g. for .NET Framework, Web frameworks, Bash, Docker etc, even Unity is in there!

There are also plugins for VS Code and Visual Studio that allow these docsets to be integrated into the editor giving you instant access to docs when on a method, for example.

 

Doc viewer for Windows, Linux and Mac OS - https://zealdocs.org/

Generating docsets for Dash, Zeal and Velocity - https://kapeli.com/docsets

Link to post

Yes, that would require to rewrite current documentation generation pipepline. That we can't afford to do right now. More likely in the future at least a Community documentation (with no Doubles) will be available in the doc sets.

How to submit a good bug report
---
FTP server for test scenes and user uploads:

Link to post