Skip to content

Conversation

@danielpeintner
Copy link
Contributor

@danielpeintner danielpeintner commented Aug 5, 2025

closes #14


Preview | Diff

@danielpeintner danielpeintner marked this pull request as draft August 5, 2025 16:03
@danielpeintner
Copy link
Contributor Author

I started to work on the section about "WoT Binding Document", see https://pr-preview.s3.amazonaws.com/danielpeintner/wot-bindings-registry/pull/17.html#binding-document

Please let me know whether it is how you envision it...

@egekorkan
Copy link
Contributor

So the parts you have changed so far are not exactly about requirements for submission. Those are at https://w3c.github.io/wot-bindings-registry/#requirements-on-the-submitted-document . This intro section is basically motivating the registry mechanism in the first place.

@egekorkan
Copy link
Contributor

@danielpeintner after working on the informative intro section and the above-linked section containing the requirements on the submitted documents, I am not sure how to handle this initial section (https://w3c.github.io/wot-bindings-registry/#intro-section-document). As the introduction sections of our documents tend to be informative, we cannot put these general requirements in there. Any thoughts?

Some ways forward:

  • Ignoring these for now and doing the other sections. We will find a place later on.
  • Creating a specific section for such overall requirements

@danielpeintner
Copy link
Contributor Author

I reverted the changes for https://w3c.github.io/wot-bindings-registry/#intro-section-document.

I also played a bit around with different possibilities "how" to style Section 6 it and I think it is best to use a simple table like shown in 6.1 Entry format.
If that is okay, I will do the same changes for the other sections in 6.

Note: Some Content in the "Additional Notes" column should go away.

@danielpeintner
Copy link
Contributor Author

FYI: I pushed updates so that the document can be somewhat looked at. Anyhow, I think there is lots of more work to come, and I think we should start splitting the content/section.

@egekorkan
Copy link
Contributor

The changes look good to me (I mean starting section 6). It might be good to merge this PR and split the sections between each other. @danielpeintner can you do the following small changes:

@danielpeintner
Copy link
Contributor Author

see 6951c34

  • Moving an editorial note that is in a table cell to below the table

see 0944586

@danielpeintner danielpeintner marked this pull request as ready for review August 18, 2025 14:14
@danielpeintner danielpeintner changed the title refactor: reformat document refactor: reformat document Section 6 Aug 18, 2025
@egekorkan egekorkan mentioned this pull request Aug 19, 2025
Copy link
Contributor

@egekorkan egekorkan left a comment

Choose a reason for hiding this comment

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

@danielpeintner I had another look and saw the need for some changes

@danielpeintner
Copy link
Contributor Author

@danielpeintner I had another look and saw the need for some changes

I think I resolved all your comments. Please take a look.
Having said that, I think we should try to re-iterate in smaller steps in future to get easier to grasp changes/diffs...

Copy link
Contributor

@egekorkan egekorkan left a comment

Choose a reason for hiding this comment

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

I agree that we should be more iterative but this was a good amount of work to get something readable and we knew it would be a big PR from the beginning. The rest of the work should be iterative from now on.

@egekorkan egekorkan merged commit 0ca09a2 into w3c:main Aug 21, 2025
1 check passed
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.

Reformat the document to look good by taking over the results of refactor

2 participants