docs: revise README #1455
Open
docs: revise README #1455
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Trying to streamline the information given in the README for "new" users (including people who have not used it in a long time).
Contributor
Author
|
Note that |
| ### As a CLI tool | ||
|
|
||
| You can alternatively use node-wot via its command line interface (CLI). Please visit the [CLI tool's Readme](<[url](https://github.com/eclipse-thingweb/node-wot/tree/master/packages/cli)>) to find out more. | ||
| You can alternatively use node-wot via its command line interface (CLI). Please visit the [CLI tool README](./packages/cli/README.md) to find out more. |
Member
There was a problem hiding this comment.
Note: I recall we were using the absolute URLs for a good reason - to show links properly if the MD document is shown somewhere else. I would tend to keep it that way...
Member
There was a problem hiding this comment.
Anyhow, I see we don't use it consistently.
Member
There was a problem hiding this comment.
I think the problem arises in npm, there relative links probably don't work. Another reason why we should move most of the doc to a proper documentation site.
Member
There was a problem hiding this comment.
Yes, I also think we should keep the full URLs
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Trying to streamline the information given in the README for "new" users (including people who have not used it in a long time).
I noticed that it is complicated with some of the duplication, e.g., https://thingweb.io/docs/node-wot/api/ or https://github.com/eclipse-thingweb/node-wot/blob/master/packages/binding-coap/README.md
We also already saw that some of the references online Things are not reachable, e.g., coap://plugfest.thingweb.io/testthing (neither HTTP nor CoAP).