search

w3c / wot-usecases

Repository of the WoT IG to discuss possible WoT use cases
https://w3c.github.io/wot-usecases/
21 stars 34 forks source link

Associate Discovery Requirement with Use Cases #242

Closed JKRhb closed 9 months ago

JKRhb commented 10 months ago

Will resolve #236.

Depends on #241.

Preview | Diff

mmccool commented 10 months ago

Note that the link format was updated to use an automatic feature of ReSpec to look up the section number and name. I like that - let's make them all like that, and I will do the same thing for Security etc.

JKRhb commented 9 months ago

I think this PR could now be ready for an initial review. I honestly had some difficulties with this task because the use-case descriptions had a lot of variation and, in some cases, it was a bit unclear if a use-case actually covered a requirement.

I think the creation (or rather: reapplying) of a uniform format for the use-case descriptions would be nice to make tasks like this one and comparison across use-cases a bit easier. Some use case descriptions were also partially outdated and might need to be updated at some point to reflect the changes that were added to the WoT specifications in the meantime.

I think a review of this PR could be conducted in two steps:

  1. Assess if I in fact listed all use cases relevant for discovery.
  2. See if the requirements are actually supported by the use cases listed underneath them. For now, I only commented out use cases from the full list to make it easier to reintegrate them into the list.

To make this PR easier to review, we could also consider splitting it into smaller chunks – let me know if you think this could make sense here.

cperey commented 9 months ago

I have, to the best of my ability, reviewed the changes and additions in the clause that describes discovery requirements and the use cases to which they are linked. It appears that only with a few exceptions, all use cases need all requirements. Let me know if there's anything more to be done from my side. Thank you for all your efforts on this important project!