search

WebView-CG / Compatibility-Data-Project

We are driving an initiative to measure compatibility between WebViews across the ecosystem. This repository is used to track tasks and the current state of the project.
https://caniwebview.com/
20 stars 7 forks source link

caniwebview: Consistent documentation #14

Open NiklasMerz opened 7 months ago

NiklasMerz commented 7 months ago

A couple consistency questions as I was writing:

  1. Do we want to start every sentence with "WebView2 will..." or "Android WebView supports..." or should we try to figure out how to skip that redundancy?
  2. Should we link to specific API pages or no?

From: https://github.com/WebView-CG/Compatibility-Data-Project/pull/12#issue-2223790238

NiklasMerz commented 7 months ago

Thanks @aluhrs13 for bringing this up. I had similar questions.

For 1. I don't have any opinion, yet. Maybe someone more experienced in writing documentation has an idea. We should also try to get the ordering of the WebViews consistent.

To 2. I would say definitely include links. caniwebview could be a good place to discover what APIs and possible issues or bugs exist. Links to documentation or bug reports could point people to the right documentation mentioned here. We have two ways to provide links here. Links can be part of the description or be included in the links section through the JSON definition. Consistency here could also be question.