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

Alling Readme to template #545

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Alling Readme to template #545

wants to merge 1 commit into from

Conversation

relu91
Copy link
Member

@relu91 relu91 commented May 15, 2024

As discussed in the marketing and main call I've been assigned (see w3c/wot-marketing#461 (comment)) to upgrade the readme of this repo with the guidelines defined in the general template. This PR is a refactoring of the current README no information should be lost (please double check). Some warning points:

  • The contributing section should probably be moved to a Contributing.md file
  • There was not git tag to point for the REC version.

Copy link
Member

@farshidtz farshidtz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for the updates.

The latest Implementation Report is available [here](https://w3c.github.io/wot-discovery/testing/report.html).
The W3C WoT collects known implementations at <https://www.w3.org/WoT/developers/>. Implementations of Discovery are found under categories
"TD Directory (TDD) Implementations", "Runtime Implementations for TD Consumers" and "Runtime Implementations for TD Exposers". Further information
can also be found in the [implementations](implementations/README.md) folder.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These are pretty outdated. I suggest removing this file and maintaining the implementations in one place only.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ok, good point 👍🏻


The latest Implementation Report is available [here](https://w3c.github.io/wot-discovery/testing/report.html).
The W3C WoT collects known implementations at <https://www.w3.org/WoT/developers/>. Implementations of Discovery are found under categories
"TD Directory (TDD) Implementations", "Runtime Implementations for TD Consumers" and "Runtime Implementations for TD Exposers". Further information
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure how useful it is to mention the heading titles. Is anyone going to read these here and try to find them there? Will anyone update the heading titles here if they change over time?

IMO, the developers page should have better grouping or labeling to make it clear which of those implement the discovery spec.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I found that pretty weird too, but I was trying to be as close as possible to the template to avoid inconsistencies. We should mention this point in wot main repository and update the template.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants