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

Why are Chapter 8 and 9 separated #630

Closed
egekorkan opened this issue Nov 2, 2021 · 4 comments
Closed

Why are Chapter 8 and 9 separated #630

egekorkan opened this issue Nov 2, 2021 · 4 comments

Comments

@egekorkan
Copy link
Contributor

When I am updating another WoT specification and want to sync the updates with the architecture specification, it is confusing that there are two places any specification can look for: Section 8 and 9 for most, 9 and 10 for Scripting API.

  • For Bindings it is 8.7 and 9.5
  • For Scripting API it is 9.6 and almost entire 10
  • For TD it is 9.1, 9.2 and bunch of subsections in 8

If we are to have information in the architecture specification that other specifications should sync with, it should be easier for other specifications to know where to update.

@egekorkan egekorkan changed the title Why Chapter 8 and 9 separate Why are Chapter 8 and 9 separated Nov 2, 2021
@mlagally
Copy link
Contributor

mlagally commented Nov 4, 2021

Chapter 8 introduces the concepts in the abstract WoT system architecture.
The Building block chapter 9 contain overview / explainer level information on the corresponding building block documents.
I hope it is not too difficult for editors of other specifications to identify the relevant parts.
Please make a contribution with a proposal if you think some specific change is needed.

@egekorkan
Copy link
Contributor Author

I think that the minimum that needs to be done is renaming building blocks to specification documents. Other comments:

  • System Architecture is almost an abstracted version of TD so I don't know the need for an extra TD chapter that needs to be synced separately. TMs are added only to the 9 whereas they are also part of the system architecture.
  • 10.3 and 9.6 are definitely mergable in a way. @relu91 or @danielpeintner ?

I think that the amount of duplication of actual text and concepts should be reduced to make it easier to maintain, which is obviously failing given the high amount of misalignments.

@danielpeintner
Copy link
Contributor

Maybe the para in 10.3 can be added to the section 10.2 which talks about WoT runtime. Scripting for me is a runtime....

@relu91
Copy link
Member

relu91 commented Nov 10, 2021

10.3 and 9.6 are definitely mergable in a way. @relu91 or @danielpeintner ?

+1 for merging, 10.2 already correctly describes how a runtime relates to the Scripting API we don't need another paragraph

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

4 participants