Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

caniwebview: Consistent documentation #14

Open
NiklasMerz opened this issue Apr 4, 2024 · 1 comment
Open

caniwebview: Consistent documentation #14

NiklasMerz opened this issue Apr 4, 2024 · 1 comment
Labels
caniwebview Web site related issue

Comments

@NiklasMerz
Copy link
Member

NiklasMerz commented Apr 4, 2024

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: #12 (comment)

@NiklasMerz NiklasMerz added the caniwebview Web site related issue label Apr 4, 2024
@NiklasMerz
Copy link
Member Author

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
caniwebview Web site related issue
Projects
None yet
Development

No branches or pull requests

1 participant