OWD project: WebXR docs

[Elchi3]

Problem statement

In 2021, we worked with Meta on creating WebXR browser compat data and MDN WebXR reference docs, see #35.
We documented features from 10 WebXR specifications and wrote 131 new MDN reference pages.

Since then, a few things have evolved. There is now https://wolvic.com/en/ and in 2024 we will see Apple Vision Pro and visionOS. They all support WebXR, so it will become a standard with multiple implementations.

We haven't updated the WebXR guide pages, there are no how-tos, and there is no coherent WebXR tutorial. Also, it is likely that the WebXR standard has evolved and that reference pages need updating and new features need to be documented.

Proposed solutions

The Divio system describes a 4-part scheme and has been guiding us to create great sets of documentation (https://documentation.divio.com/).

We should make sure to have updated reference docs and compatibility information for all relevant XR devices in 2023/2024.

We should create guides that describe the different WebXR modules for VR, AR, Inputs, and integration with APIs like WebGL, WebGPU, Gamepad, and more.

Task list

There are ideas from two years ago when we worked with Meta, see this MDN content issue mdn/content#7276

We should talk to Wolvic, and Apple Vision Pro, and other XR Subject Matter Experts to figure out a good content plan for WebXR docs now that the technology becomes available more broadly.

Roughly, we would need:

• Updated reference docs
• Guide pages to give an overview of WebXR
  • Especially guides for Performance and accessibility.
• How-to pages with practical code snippets to get particular tasks done using WebXR and related technologies
• One or more tutorials that build a sample WebXR application that works cross-browser and cross-device using WebXR, and related technologies such as WebGL, WebGPU, Audio, Gamepad, etc.

Priority assessment

• Effort: (given no current OWD writer is an XR SME and needs to get into the topic) ~12 weeks, likely more.
• Dependencies: XR SME is needed for technical guidance and review
• Community enablement: We should talk to the XR community and raise awareness about this project.
• Momentum: High, given Apple Vision Pro in 2024.
• Enabling learners: Ideally, the guides, how-tos and tutorials can enable learners who haven't written XR apps before.
• Enabling professionals: Updated reference docs are important. We don't want to leave them with the 2021 version of MDN's XR docs.
• Underrepresented topics / Ethical web: n/a given how pricey and high-end this tech is. We should make sure to document all accessibility aspects of this tech to include as many people as possible.
• Operational necessities: no.
• Addressing needs of the web industry: I currently have no surveys or market studies to quote here. Please let me know if anyone has data points.

More information

Open Web Docs (OWD) is a non-profit collective funded by corporate and individual donations.

In order for this project to happen, please consider donating to OWD on https://opencollective.com/open-web-docs.
For more information on sponsorship and membership tiers, see https://openwebdocs.org/membership/

More information is available at https://openwebdocs.org/.
For questions, please reach out to florian@openwebdocs.org.

[msub2]

I'd be interested in potentially contributing to this/raising awareness to the existing WebXR community. The checklist of articles from the old issue seems to be outdated now though, is there a more up-to-date outline of which pages need creation/editing by a SME? I've done some work in the past on some basic WebXR tutorials here, though those are centered on the various popular frameworks/engines used for WebXR content creation. Curious whether the sample application you have in mind would be leveraging one of those frameworks (like three.js) or if you'd prefer a more strictly WebGL-based approach for rendering.

[Elchi3]

Hey @msub2, sorry for the slow response! Glad to hear you're interested in contributing! We haven't looked into WebXR docs in a while and I think a first step would be to come up with an updated plan for it. I guess the last plan we made is in mdn/content#7276. On MDN, we mostly focus on documenting the vanilla web standards approach. If using frameworks like threejs, then the question also comes up if it should rather be living with the threejs docs or what would be best.

We're in the process of setting up a W3C Docs Community Group and maybe we could have a conversation about WebXR docs sometime soon and invite some members of the W3C Immersive Web WG as well for making a plan. You can join the Docs CG here: https://www.w3.org/community/docs-cg/