documentation icon indicating copy to clipboard operation
documentation copied to clipboard

Contribute a docset to Dash

Open underyx opened this issue 9 years ago • 4 comments

Dash is a documentation searcher/browser app for macOS (it also has independent reimplementations for other platforms).

https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset

underyx avatar Jul 19 '16 16:07 underyx

Can you open an issue at dash?

On 19 Jul 2016 18:58, "Bence Nagy" [email protected] wrote:

Dash is a documentation searcher/browser app for macOS (it also has independent reimplementations for other platforms).

https://github.com/Kapeli/Dash-User-Contributions#contribute-a-new-docset

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/coala-analyzer/documentation/issues/5, or mute the thread https://github.com/notifications/unsubscribe-auth/AFc6KF8169EfxFUiHTs-e8_dPDUlC_mbks5qXQJIgaJpZM4JP8TC .

sils avatar Jul 19 '16 17:07 sils

I'd rather not, the bears don't even have HTML doc generation set up yet I believe, and I really doubt that anyone would just pick up requests from the Dash repo.

I wanted to open this issue in some meta issue tracker for coala but this is the best repo I've found. Getting coala on devdocs.io would be an example of an issue that would be related and nice to track in the same place as this one. If I were to open one for devdocs.io it'd be stuck for quite a while since they require >3k GitHub stars.

underyx avatar Jul 19 '16 17:07 underyx

@Monal5031 , can you investigate what is involved. Is it a possible GCI task? Do we have all the necessary content written? Or is it too big?

jayvdb avatar Nov 23 '17 19:11 jayvdb

Yeah, this can be a GCI task but is it okay to have a PR over dash repo and count it as a GCI task? , also it requires info on how to generate the docs and little bit of json I guess this goes a little above newcomers.

A sample is given there on how to contribute the doc https://github.com/Kapeli/Dash-User-Contributions/tree/master/Sample_Docset According to the sample doc I think we have all the necessary things

  • [x] Author
  • [x] Instruction to generate the doc P.S.: We'd still have to think about having a GCI PR in another repo.

Monal5031 avatar Nov 23 '17 20:11 Monal5031