search

w3c / webdriver-bidi

Bidirectional WebDriver protocol for browser automation
https://w3c.github.io/webdriver-bidi/
372 stars 42 forks source link

Create CDDL Index section #101

Open gsnedders opened 3 years ago

gsnedders commented 3 years ago

Bikeshed generates IDL Index sections; e.g., https://drafts.csswg.org/cssom/#idl-index

We should have similar sections grouping together local and remote ends of CDDL productions.

christian-bromann commented 3 years ago

I would be interested to help with this. What would be the best way to update the document automatically based on the generated CDDL? The parser that I've written currently has no schema validation but it is something I wanted to add. The idea workflow seems to be: changes are done in the spec ▶️ Github Action parses out all CDDL snippets from the spec ▶️ validates the CDDL and ▶️ if valid updates the index section at the bottom of the spec with an automated commit.

gsnedders commented 3 years ago

I think the ideal solution (and to tackle #100 as well) would be to teach Bikeshed about CDDL so it can do all of this itself.

foolip commented 3 years ago

I think that the ideal implementation of this would be to teach Bikshed about <pre class=cddl> to some extent, similar to how it's aware of Web IDL snippets. The most ambitious would be parsing, validating and syntax highlighting, but at the very least an index. If that sounds good, a new issue in https://github.com/tabatkins/bikeshed/issues and asking Tab how to implement it would be a good next step.