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

Highlight normative sections via links in introduction #772

Closed
egekorkan opened this issue May 24, 2022 · 5 comments · Fixed by #794
Closed

Highlight normative sections via links in introduction #772

egekorkan opened this issue May 24, 2022 · 5 comments · Fixed by #794
Assignees
Labels

Comments

@egekorkan
Copy link
Contributor

Follow-up of #629, we should put some links in the introduction about the normative sections that come later in the document

@mlagally
Copy link
Contributor

mlagally commented Jul 4, 2022

There's already a corresponding section in the introduction:

This specification serves as an umbrella for W3C WoT specifications and defines the basics such as terminology and the underlying abstract architecture of the W3C Web of Things. In summary, the purpose of this specification is to provide:
a set of application domains in 4. Application Domains that were considered to identify use cases for the W3C WoT Architecture,
a set of common deployment patterns in 5. Common Deployment Patterns,
a definition of the abstract architecture in 6. Abstract WoT System Architecture,
an overview of a set of WoT building blocks and their interplay in 7. WoT Building Blocks,
an informative guideline on how to map the abstract architecture to possible concrete implementations in 8. Abstract Servient Architecture,
informative examples of possible deployment scenarios in 9. Example WoT Deployments,
and a discussion, at a high level, of security and privacy considerations to be aware of when implementing a system based on the W3C WoT architecture in 10. Security Considerations and 11. Privacy Considerations, respectively.

@mlagally mlagally added the close label Jul 4, 2022
@mlagally
Copy link
Contributor

mlagally commented Jul 4, 2022

@egekorkan
Not sure what you are missing, can we close this issue?

@egekorkan
Copy link
Contributor Author

So the main reason behind this issue is the fact that the arch spec has quite a bit of normative text that gets lost behind the informative introduction which goes way further than what an introduction should be. This results in readers (including the WG) not taking the specification seriously which actually has assertions that affect all the other WoT specifications. This was the minimum effort needed to fix this problem

@mlagally
Copy link
Contributor

mlagally commented Jul 4, 2022

@egekorkan
Please review #794 and let me know of any further suggestions for improvements.

@egekorkan
Copy link
Contributor Author

@egekorkan Please review #794 and let me know of any further suggestions for improvements.

Thanks @mlagally , it looks good to me :)

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

Successfully merging a pull request may close this issue.

2 participants