OpenGLESDashDocset icon indicating copy to clipboard operation
OpenGLESDashDocset copied to clipboard

Contribute docset to Dash

Open Kapeli opened this issue 11 years ago • 2 comments

I've set up a repo where users can contribute docsets to Dash. You can check it out at https://github.com/Kapeli/Dash-User-Contributions. It should contain all the info you need to get started.

Docsets that are contributed in this way will appear in a separate User Contributed section under Dash's Preferences > Downloads (i.e. just like the current Ruby Gems or Cocoa Pods sections).

If you need any help with this, don't hesitate to contact me. Thank you!

Kapeli avatar Apr 18 '14 00:04 Kapeli

@Kapeli Gladly! I am a bit confused about how to version the docsets for OpenGL however. ES 1, 2 and 3 and different docsets instead of ES 3 being an updated version of ES 2 and so on. Are you expecting different docsets for ES 1, 2 and 3 or just one? I can of course keeps updating (and fixing issues) in these docsets and provide updates using the "Add the /" mechanism.

chinmaygarde avatar Apr 18 '14 03:04 chinmaygarde

You can do whichever you think is best. You can split your docset by major versions if you want, so you can have OpenGL ES 1, OpenGL ES 2 and OpenGL ES 3. This is also in-line with what I do with the OpenGL docsets I maintain. If you go this route, add this key in docset.json - "major_versioned": true, after that you can name your docset OpenGL ES 1 and have your version set to .1 and Dash will display everything as OpenGL ES 1.1.

You can also have only one docset - OpenGL ES and add the older versions as separate downloads.

Kapeli avatar Apr 18 '14 10:04 Kapeli