search

ably / specification

The Ably features spec for client library SDKs.
Apache License 2.0
0 stars 4 forks source link

Build textile to html #4

Closed QuintinWillison closed 2 years ago

QuintinWillison commented 2 years ago

We need the Textile source files rendered for preview and consumption by client library developers.

For the time being I've made the decision not to convert any of the textile files to a more modern and friendly format like markdown. This is mainly because it's useful to keep the rich Git commit history currently visible against the textile files (as duplicated over from the ably/docs repository).

I'm also trying to keep this build as simple and self-contained as possible, with minimal reliance on bigger frameworks or many other dependencies. Therefore, pulling this together with just a basic Handlebars implementation fed with output from Redcloth feels appropriate and maintainable. Plus, Tailwind CSS for styling, which is most sensibly deployed natively using Node.js - so, using npm to run things, which makes sense (calling down to Ruby scripts when required).

Use the View deployment button on this pull request to see the rendered result.

QuintinWillison commented 2 years ago

Obsolete Comment: The failure of the 'Assemble' workflow is expected. I will run it again once we've release v2 of the SDK Upload Action, which will include https://github.com/ably/sdk-upload-action/pull/46.