what is supported and what isn't?

[sichvoge]

Hi @wdullaer,

First, very nice work - looks great and having it as a theme for raml2html is definitely a great win!

Second, can you highlight what things are currently not supported so that I know what to look out for and not raise as a bug :)

My test base is the this example (also the one that raml2html has) and there are information not rendered yet.

Thanks,
Christian

[wdullaer]

You create issues for every feature that's not supported.
I have built this until all the stuff I needed at work rendered properly, but I know it doesn't cover the entire spec.

So if something is missing, just create an issue :-)

[ulaBLUE]

Thanks for your work.
One thing I have noticed is if there are multiple examples for each type like json and xml, then only one of the example is shown.

[wdullaer]

Currently only examples with content-type application/json are shown.
I'm looking into ways of showing more examples

[wdullaer]

I've added support for multiple content-types, response headers and automatic example generation in the digital-ocean style branch.
I'm currently cleanup up that branch and writing more docs, but I'd appreciate it, if someone could give it a spin to see if your APIs still render properly

[sichvoge]

Sure. I'll spend some time this week!

[wdullaer]

Excellent. Looking forward to your feedback.
I'm currently refactoring / cleaning up and writing some more docs for the new features.

Small tip to experiment with: in the documentation section you can push content to the right hand column by using an hr in your markdown.

This will be in the middle column. The standard behaviour
---
This text will be rendered in the right column where the code examples live as well

This pattern is not yet supported in the description of API methods (I tried some things, but there were too many gotcha's there)

[sichvoge]

@wdullaer I did a quick check. Very nice indeed. I created a few issues that I have found during my quick review. How does your backlog currently look like?

[wdullaer]

Currently, I want to release the digitalocean-style branch as version 2.
Other than that, I think the most "pressing" issue is the lack of schema / type support right now.
I also think the table structure describing the parameters can use some improvement, but my minimal graphic design skills are failing me there.

I have built this for a project in my day job, but have since moved on, so I don't have any pressing personal reasons to push it forward. It'll depend on how much feedback I get, how much people I can make happy by continuing hacking on this. (there's only so much spare time in a week)

[sichvoge]

Sure, I understand. I think the styling on the tables is actually fine and for me, the lack of schema/type could be the killer for people. Everything else is pretty nice.

From my side, as I do with raml2html in general, I can tweet about that or announce the availability on the RAML forums, etc.; so that people will know about it.

[wdullaer]

I'll take a look at adding type information over the coming weeks.
Thanks for the support in any case :-)

[sichvoge]

Sure. I think that theme you created is brilliant and really want to make sure it takes off.

For me @kevinrenskers made a brilliant move to allow theming in raml2html and you can build such a great experience on top.