docs(v2): update Client API docs page

[Simek]

Motivation

This PR updates the Docusaurus Client API page and includes following changes:

• consistent usage of const instead of function,
• detailed method definitions moved from headings to the code blocks for usePluginData and useAllPluginInstancesData hooks, this improves the readability of ToC
• added and updated line highlighting in examples.

Have you read the Contributing Guidelines on pull requests?

Yes.

Test Plan

Changes have been tested on Docusuaurs V2 website locally.

Related PRs

No.

[netlify]

Deploy preview for docusaurus-2 ready!

Built without sensitive environment variables with commit 4159983

https://deploy-preview-3835--docusaurus-2.netlify.app

[lex111]

How about using special comments (like highlight-next-line, highlight-start, and highlight-end) for syntax highlighting? https://v2.docusaurus.io/docs/markdown-features/#line-highlighting
This is a more flexible approach.

[Simek]

How about using special comments (like highlight-next-line, highlight-start, and highlight-end) for syntax highlighting? https://v2.docusaurus.io/docs/markdown-features/#line-highlighting
This is a more flexible approach.

I think it depends on the use-case, current approach might be more useful (less cluttering) for example, for highlighting single line.

In this PR I have just followed the current style used on the docs page, but I will consider using the syntax you have suggested in the future.

[lex111]

Fair enough. Before merge, let's just change the order follow of the method signatures to ensure consistency again. I mean, do it by analogy as for useDocusaurusContext section (https://deploy-preview-3835--docusaurus-2.netlify.app/classic/docs/docusaurus-core#usedocusauruscontext), which can be divided into three parts: description, signature/definition, usage example. I propose apply this pattern to all other methods on the page.

[slorber]

thanks :)