Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation improvements #195

Open
dmoranj opened this issue Jan 17, 2017 · 2 comments
Open

Documentation improvements #195

dmoranj opened this issue Jan 17, 2017 · 2 comments

Comments

@dmoranj
Copy link
Contributor

dmoranj commented Jan 17, 2017

  • 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.
@jason-fox
Copy link
Contributor

I believe this Issue was fixed with the amendment of the README.md into standard-readme format #301 @fgalan - what do you think? Should it be closed?

@fgalan
Copy link
Member

fgalan commented Apr 2, 2019

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.

KeshavSoni2511 added a commit to KeshavSoni2511/iotagent-ul that referenced this issue Apr 24, 2023
KeshavSoni2511 added a commit to KeshavSoni2511/iotagent-ul that referenced this issue Apr 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants