-
Notifications
You must be signed in to change notification settings - Fork 1
refactor: reformat document Section 6 #17
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
Conversation
|
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... |
|
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. |
|
@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:
|
|
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. Note: Some Content in the "Additional Notes" column should go away. |
|
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. |
|
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:
|
…he table see github.com/w3c/pull/17#issuecomment-3194686439
see assertion
see 6951c34
see 0944586 |
egekorkan
left a comment
There was a problem hiding this 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
Co-authored-by: Ege Korkan <[email protected]>
Co-authored-by: Ege Korkan <[email protected]>
I think I resolved all your comments. Please take a look. |
egekorkan
left a comment
There was a problem hiding this 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.
closes #14
Preview | Diff