search

mulesoft-labs / raml-generator

Generate files from a RAML document and Handlebars templates
Other
31 stars 11 forks source link

Provide a better README #19

Open kevinduffey opened 7 years ago

kevinduffey commented 7 years ago

The README is lacking quite a bit of detail to offer more examples and such of how to use raml-generator. It would be nice to show some content on how to use the handlebars templates, as well as using the RAML 1.0 JS parser to parse any RAML 1.0 document, how to navigate through libraries, types, and more.

sichvoge commented 7 years ago

Hi @kevinduffey. The raml-generator actually does not depends on a specific template framework anymore. You need to provide what framework you will use.

The object that is going into the template framework (like handlebars) is the RAML 1.0 parser JSON object. There is nothing to really document since every framework handles stuff differently.

kevinduffey commented 6 years ago

I added this to the raml-javascript-generator as well.. the READMEs are NOT helping push RAML forward people. Lets put some thought into them, get more info, details, examples, etc. This generator is a very powerful tool, yet the README makes it seem like its nothing special. The ability to use this to literally generate any sort of output from RAML should be detailed with use cases, examples, etc. While I realize tools like RAML2HTML, RAML2JAXRS and others do their own thing.. you could more or less recreate those tools using this one with templates. So why are we not doing that? Lets brag about this generator and get more details as to its use, how to use it, example templates that detail the parsing process.. resources, traits, resourceTypes, raml types, annotations etc. Lets show an example of how to find custom annotations and do something with them.