Open Web Docs worklog, August 2021 edition
Published on September 6, 2021 by Florian Scholz
Welcome to the seventh edition of the OWD worklog. This series reports on our workstream activities and contributions we’re making to open web documentation projects, like MDN Web Docs. We had a fantastic month! In this edition, you can find a summary of what we accomplished in August 2021.
Estelle Weyl joined the team
We’re super excited to announce that Estelle Weyl joined our team as a full-time Sr. Technical Writer and Developer Advocate. Please join us in welcoming her and read more in the announcement post!
Open Web Docs signs the Diversity Charter
We signed the https://diversitycharter.org. Diversity and inclusion at conferences and events, (and everywhere) is important because we want them to be better for everyone.
Open Web Docs supports web platform documentation for the benefit of web developers & designers worldwide. We intend to emphasize diversity and inclusion across all our efforts including project contributions, community organization, tech events, and resource allocation.
— Florian Scholz, on behalf of Open Web Docs.
— Florian Scholz, on behalf of Open Web Docs.
Read the full statement on our GitHub repository.
Content work
WebXR reference docs
We wrote new reference pages for WebXR APIs. A total of 56 new pages have been contributed and the following Augmented Reality modules are now documented on MDN Web Docs:
- WebXR Anchors: XRAnchor, XRAnchorSet
- WebXR Depth Sensing: XRDepthInformation, XRCPUDepthInformation, XRWebGLDepthInformation
- WebXR Hit Testing: XRHitTestSource, XRTransientInputHitTestSource, XRHitTestResult, XRTransientInputHitTestResult, XRRay
- WebXR Lighting Estimation: XRLightEstimate, XRLightProbe
Thanks to Ada Rose Cannon (Samsung Internet), Dominic Cooney (Facebook), and Joe Medley (Google) for helping with reviews and code examples for this work, and for all that they do.
There is an open issue about updating the MDN WebXR guide material as well. Let us know what you think about the plan. In the meantime, to play with these exciting new APIs, see Ada’s post on how to use new AR features with WebXR and AFrame.
The work on the reference docs will continue in September when we will add missing content for VR modules like Hand Input and Layers. See our tracking issue for a list of APIs we’ve identified.
Markdown
We converted several sections of the docs into Markdown, including:
- CSS: https://developer.mozilla.org/en-US/docs/Web/CSS
- HTTP: https://developer.mozilla.org/en-US/docs/Web/HTTP
- The WebXR part of the Web/API documentation
We’re currently at 2,374 pages in Markdown and 9,393 in HTML. We’ve also been working on converting the Web/API documentation (more than 6,000 pages) and expect to publish that in September.
HTTP/2
This month we did the preparation work to document HTTP/2. We started by converting our HTTP documentation to Markdown, then made a plan for 6 new documents about HTTP/2. The next step is to actually write them 😜
ARIA roles
We started work on converting the ARIA roles section to Markdown, updating all the roles, and creating new reference pages for some missing ARIA roles. We also worked on improving linkages within accessibility documentation, and from roles to semantic HTML that should be used instead of ARIA.
PR reviews
In August we reviewed 332 pull requests to GitHub repositories in the https://github.com/mdn organization.
Next month
In September, we’re planning to:
- Finish converting Web/API documentation to Markdown, and make a good start on the remaining parts of the docs.
- Add more WebXR reference docs
- Finish documenting HTTP/2.
- Finish documenting all the ARIA roles
And this concludes our August update! Until next month, when we return to update you about our September activities, you can reach us at @OpenWebDocs. Want to join us? Visit https://openwebdocs.org.
🚀 1