search

whatwg / spec-factory

WHATWG Standard repository templates and infrastructure
Creative Commons Zero v1.0 Universal
34 stars 33 forks source link

Align on a README #49

Closed annevk closed 1 year ago

annevk commented 1 year ago

This doesn't cover all standards (Compatibility, Console, File System, Fullscreen, HTML, and Streams are excluded for now), but hopefully we can get there in incremental steps.

annevk commented 1 year ago

I think this better addresses the remaining feedback.

The idea is that you can have a shared README section across specifications that hopefully eventually we can standardize upon somehow (one way or another) and each specification also gets a READMEEND section they maintain locally and that is pulled in when doing a spec-factory deploy.

READMEEND is useful for URL so it can discuss reference implementations and HTML will be able to talk about Blame, etc.

annevk commented 1 year ago

I guess "README-addition-anne" needs to be called out in https://github.com/whatwg/spec-factory/blob/main/README.md as it doesn't end in .template. Perhaps we should call them something along the lines of README.md.anne.template-part and call out .template-part even though it doesn't really have any particular meaning beyond that?