Move README content into TypeDoc-compatible code comments

[steveluscher]

Motivation

If the developer is unaware of the presence of the README files in each subpackage, or has not yet found the READMEs rendered at https://solana-labs.github.io/solana-web3.js, they may have questions that are answered by those READMEs.

Let's move (or perhaps copy) all of the content possible into the code itself, in a format that's compatible with TypeDoc. This will bring all of that knowledge into developers' IDE, on hover et al.

Details

• Read the TypeDoc specification (link)
  • Get really familiar with all of the tags available, and how you would use them to express the documentation
  • Become expert at creating declaration references, so that all of the documentation autolinks to all of the rest.
• Constantly test the docs rendered by your PR in VS Code. Supply screenshots when appropriate
• Constantly test the HTML docs rendered by your PR using pnpm compile:docs
• Make many of the smallest PR you can, so that each change can be reviewed easily

[github-actions]

Because there has been no activity on this issue for 7 days since it was closed, it has been automatically locked. Please open a new issue if it requires a follow up.