I'm not sure if this is the right place to report a documentation bug, but I couldn't find anywhere else. Please let me know if there is a more appropriate place.
The API documentation page (http://doc.freenas.org/9.3/freenas_api.html) says the following:
"reStructuredText is an easy-to-read, lightweight markup language that provides an HTTP implementation of functions, known as resources, which are available beneath a specified base URL."
This sentence seems to be referring to both reStructuredText (reST) and a REpresentational State Transfer (REST) API. As far as I can tell, this entire section should only refer to the API, and the only link to reST is the format that the documentation itself is written in. The link in the previous sentence also refers to http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html when something like http://en.wikipedia.org/wiki/Representational_state_transfer would be more appropriate.
The API documentation page (http://doc.freenas.org/9.3/freenas_api.html) says the following:
"reStructuredText is an easy-to-read, lightweight markup language that provides an HTTP implementation of functions, known as resources, which are available beneath a specified base URL."
This sentence seems to be referring to both reStructuredText (reST) and a REpresentational State Transfer (REST) API. As far as I can tell, this entire section should only refer to the API, and the only link to reST is the format that the documentation itself is written in. The link in the previous sentence also refers to http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html when something like http://en.wikipedia.org/wiki/Representational_state_transfer would be more appropriate.
Last edited:
