iotagent-ul icon indicating copy to clipboard operation
iotagent-ul copied to clipboard

Published 20 hours ago • verified publisher icon telefonicaid

Documentation improvements

Open dmoranj opened this issue 8 years ago • 2 comments

  • https://github.com/telefonicaid/iotagent-ul/blob/master/README.md: The apiary link is broken: https://github.com/telefonicaid/iotagent-ul/blob/master
  • Links to the "Protocol section" are not working. Something seems to be broken with the "#protocol" anchor.
  • The sentence "This transport protocol binding has not been implemented yet" is obsolete and should be removed.
  • The sentence "This transport protocol binding is still under development" is obsolete and should be removed.
  • Typos: "API Reference section;" -> "API Reference section.", "entity.T" -> "entity.", sepparated
  • InstallationGuide: the order of sections Configuration-Packaging in IoTA-UL and IoTA-JSON are reversed. They should be homogeneous.

dmoranj avatar Jan 17 '17 10:01 dmoranj

I believe this Issue was fixed with the amendment of the README.md into standard-readme format https://github.com/telefonicaid/iotagent-ul/pull/301 @fgalan - what do you think? Should it be closed?

jason-fox avatar Apr 02 '19 10:04 jason-fox

Not fully sure... Some of the bullet list items are of that nature and I'd say they are solved. But for others I'm not sure.

A per item analisys should be done.

fgalan avatar Apr 02 '19 13:04 fgalan