[WIP] - Html Docs 2 - API and Client Library Documentation - Feedback / Assistance wanted

[ghost]

Hello All!

Further to an attempt at creating some 'slack' style docs, Here's a WIP of a HTML documentation format, in brief here's what I'm trying to achieve with these docs;

• Nice fresh tidy documentation (Based on JSDoc format)
• Jsonschemaview for parameter and response definitions
• Formatted/Highlighted example responses
• Client Library / SDK Code samples in a tabbed interface for popular languages (Taking code samples from Readme's in each language)
• All rendered into a single HTML file (As opposed to lots of dependencies) that can be saved/emailed/ rendered in realtime / whatever

Here's an image of where I'm at

In general I think its working well, The code samples need some more attention, I think I'm going to come up against an issue where some languages require different casing for the same thing, so may have to start utilizing some more vendor extensions / hacks!

This may be an ongoing project

Anyway,

Would appreciate any feedback / advice / assistance :) Tag anyone who may be interested! Thanks for reading!

[ghost]

p.s. If you want to merge feel free, nothing will actually break the build, Just needs template improvements :)

[wing328]

@jhitchcock thanks for the PR.

I think I'm going to come up against an issue where some languages require different casing for the same thing, so may have to start utilizing some more vendor extensions / hacks!

If you can list out the casing required for the variables (e.g. operationId), we can start adding those mustache tags so that you can use them directly without using vendor extensions.

[wing328]

This also fixes #1387

[wing328]

@jhitchcock thanks for the contribution. PR merged.

[ghost]

Many Thanks, I'll add the extra tags as I do new languages and improve the templates. Hopefully others will contribute too!