search

w3c / deviceorientation

W3C Device Orientation spec
https://www.w3.org/TR/orientation-event/
Other
49 stars 32 forks source link

chore: Update README.md #178

Closed marcoscaceres closed 6 months ago

marcoscaceres commented 6 months ago

Update README to reflect joint deliverable status.

marcoscaceres commented 6 months ago

@anssiko see the Geolocation one. I think it’s quite good, as it gives a good overview of the API and purpose. We could do something like that here as a follow up.

anssiko commented 6 months ago

Geolocation API readme examples are great and could be contributed to MDN developer docs when appropriate to reach more web developers.

I was thinking of a minimal baseline spec repo readme with information on how to contribute, how to build. Something that first into one page. I'm fine with repos having custom readmes, it gives them character.

marcoscaceres commented 6 months ago

Geolocation API readme examples are great and could be contributed to MDN developer docs when appropriate to reach more web developers.

MDN has a really good guide

I guess if anything, we should probably remove the examples from the Geo README and point people to that 😅 (and maybe we could modernize what's on MDN).

I was thinking of a minimal baseline spec repo readme with information on how to contribute, how to build. Something that first into one page. I'm fine with repos having custom readmes, it gives them character.

I still think that's better handled by the CONTRIBUTING.md ... For instance, the one for Web Manifest contains how to build instructions, style guide, etc.

https://github.com/w3c/manifest/blob/main/.github/CONTRIBUTING.md

I personally prefer keep the READMEs minimal and without any duplicative information.... more like, if you want to contribute, read CONTRIBUTE.md, if you want to do Y, read Y.MD... and so on.