petrochenko-pavel-a / raml-js-parser2-issues

0 stars 0 forks source link

Use tables and links to specific section instead of text only #11

Closed VasiliyLysokobylko closed 8 years ago

VasiliyLysokobylko commented 8 years ago

Currently, the spec has tables, text, and only few links. We want to improve the content by introducing a better table structure that basically contains the key name of a property, the value type (with link to the specific section), and a description.

For example, the value of the documentation node should look like the following:

Key Name Value Type Description
title string Non-empty string that represents the title of an individual document.
content string Non-empty markdown string that contains the content of an individual document.

That approach has to be applied consistently throughout the spec. Any redundant text should be also removed.

VasiliyLysokobylko commented 8 years ago

https://github.com/raml-org/raml-spec/issues/323