Browser: Use consistent naming and formatting

[inancgumus]

We want to clarify and maintain consistency in the name usage of the components within the documents. Currently, there are some inconsistencies throughout the documentation, which can be confusing for users.

Issue 1

For example, here:

"A single BrowserContext can have many pages."

We use BrowserContext in a code block and link to it. However, we neither capitalize nor link the page part. Should pages be Pages as a link, or an easier-to-read way like pages as a link?

• Using pages as a link is easier to read in a sentence.
• Using Pages as a link might be easier to understand the relationship between all the components.

Other examples:

• https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/page/close/
• https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/page/close/
• https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/page/ischecked/

Issue 2

Another issue is that sometimes we write component and method names in a code block as a link, sometimes without a link, and in others only as a link without a code block.

Example: https://grafana.com/docs/k6/latest/javascript-api/k6-experimental/browser/page/evaluatehandle/

---

Conclusion

• While referring to the types, using [Cookies](link) is OK. But [cookies](link) is not.
• In self-referential pages, we won't put concepts in a code block. For example, in the BrowserContext documentation, it doesn’t make sense to put BrowserContext in a code block. We can call it as just “browser context”.
• Having type prefixes in a type’s documentation doesn’t make sense, and we'll remove the prefixes. For example, in Page, it doesn't make sense to say Page.click, it can be just click.