Skip to content
#

raml

Here are 208 public repositories matching this topic...

kevinrenskers
kevinrenskers commented Apr 5, 2018

I'm seeing more and more raml2html themes on NPM, which is awesome! And also makes it painful that the process of writing themes is not documented anywhere. We provide the default theme and a Markdown theme which should be good examples to copy from, but that's about it.

  1. Themes can provide index.js with their own config object (or a function that returns such config object)
  2. Or they can
timur-han
timur-han commented Nov 16, 2017

Hello,

Is there any documentation of this project somewhere else? The readme.md provided is not comprehensive / self-contained. The configuration effort for a new user is not that less and the documentation is not explanatory for this. One needs to check the actual implementation to understand what is actually meant and it is not always sufficient to get the things working.

dberlind
dberlind commented Aug 5, 2016

Hey all,

Just a comment that I think the Documentation tab (do you call this a tab, or a button?) should be re-named to "Description" as it will add a Description element to whatever node you are on and not a Documentation element. When I see "Documentation", I intuitively think this is going to add a Documentation node to the root of the RAML doc.

![image](https://cloud.githubusercontent.com

rowa97
rowa97 commented Sep 18, 2019

Describe the bug
When adding a description to a path parameter, header, or query parameter in design view, the field displays improperly and cannot be used.

To Reproduce

  1. Create a Path Parameter, Header, or Query Parameter in design view
  2. Add a description by clicking the book icon

Expected behavior
A field appears that allows you to add a description.

**Screensh

bug
bpytlik
bpytlik commented Aug 7, 2015

When an example isn't valid JSON, the error you get looks like this:
AssertionError: Invalid JSON:
undefined
Error: expected [Function] to not throw an error but 'SyntaxError: Unexpected string' was thrown

Followed by a stack trace. It would be nice if:
a) the error identified that it was the example and not the json schema that was invalid.
b) the error provided more information about what

kevinduffey
kevinduffey commented Jul 4, 2018

Lets put some more content.. a lot more in the README. I dont have a good idea of what this project does, why you would use it, examples of how to use it, etc. The README is the place for this sort of stuff (or at least links to examples, etc). The current README leaves a lot to be desired as to the purpose and use of this project.

Improve this page

Add a description, image, and links to the raml topic page so that developers can more easily learn about it.

Curate this topic

Add this topic to your repo

To associate your repository with the raml topic, visit your repo's landing page and select "manage topics."

Learn more

You can’t perform that action at this time.