Progress on bikeshed for spec

Hi Folks,

Bikeshed is a specification preprocessor, used by W3C , whatwg, TC39 and 
others. You write in markdown, and it generates a lot of markup, 
automatic links, bibliography, W3C mandatory status boilerplate, and so 
forth.

I created two bikeshed files in the PFE repo

   https://github.com/w3c/PFE

Overview.bs is for the actual PFE specification and has some minimal 
starter text.

example.bs is longer and can be used as an example of how to do things; 
it is copied from the CSS WG example document, with some irrelevant 
parts deleted and a couple of changes to make it more relevant.

Neither of these will work /yet/, because the group name `webfontswg` is 
not known to bikeshed so it can't pull in the status boilerplate. That 
will be fixed once this pull request gets merged:

   https://github.com/tabatkins/bikeshed/pull/1924

I added the boilerplate files based on the W3C Audio WG, whose files are 
simpler than the more involved CSS WG ones. (I'm in both groups).

Meanwhile, anyone who intends to edit the specification, and doesn't 
already have bikeshed installed, should look through the documentation

   https://tabatkins.github.io/bikeshed/

and check out and build bikeshed

   https://github.com/tabatkins/bikeshed

Once this is working, you generate the spec with

   bikeshed spec Overview.bs

and it makes Overview.html. I suggest we commit that in the repo too, 
and use gh-pages on the main branch so we can serve an editors draft. 
That means that editors should edit Overview.bs, make the spec, then 
commit both Overview.bs and Overview.html.

Myles - This isn't how CSSWG does it, but they have a whole complex 
separate server which auto-builds the spec and generates cross-reference 
indices among the 100 or so CSS specifications, and we don't need all that.


-- 
Chris Lilley
@svgeesus
Technical Director @ W3C
W3C Strategy Team, Core Web Design
W3C Architecture & Technology Team, Core Web & Media

Received on Tuesday, 26 January 2021 16:59:24 UTC