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
samples: webusb: Host webusb demo app directly on zephyr doc #62420
Conversation
1b24599
to
73b3d83
Compare
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.
That's awesome - thanks!
Consider my only comment as non-blocking.
Note: the demo page is effectively <html>
within <html>
which is probably a bit hackish and not really w3c compliant, but I'd say the tradeoff is worthwhile (plus, people have the link to the raw source if needed).
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.
While I appreciate that you kept commit authorship set to myself for the first commit, it doesn't look right as it probably doesn't compile as-is. Maybe just squash the first two? Or, probably better, re-order with a first commit that moves "your" code to clearly show it's you that's contributing this, and then do the rest with co-authored-by in a second commit.
Thanks again!
Copy file index.html from the external repository finikorg/webusb-sample. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Include demo.rst to the webusb sample documentation. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
Include only README.rst to docs, skipping helpers included with :doc: directive. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
Update webusb README with recent changes after index.html was moved to sample from the external repository. Signed-off-by: Andrei Emeltchenko <andrei.emeltchenko@intel.com>
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 spotted a few other issues in the HTML document by putting it through a validator, could you please have a look
samples/subsys/usb/webusb/index.html
Outdated
@@ -0,0 +1,125 @@ | |||
<html> |
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.
Just realized it would probably make sense to run this file through a code formatter
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.
BTW, you can make commit and push it to this branch after my commits.
417a91c
Running the HTML code through W3C Validator revealed several issues with the markup that this commit fixes. Signed-off-by: Benjamin Cabé <benjamin@zephyrproject.org>
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.
ack @kartben commits
Didn't realize I was blocking this, sorry. Dismissing my own review as I am not in a position to +1 now that I've added commits to this. Luckily it now has enough approvals though :)
Move artifacts from private repository to zephyr docs.
Fixes: finikorg/webusb-sample#3