Documentation improvements

[LesnyRumcajs]

Issue summary

This is an umbrella issue for the documentation improvement initiative for 2024.

Scope

• Conduct workshop to review examples of node documentation and identify pros/cons
• Define a structure for the updated documentation
• Refactor existing docs to satisfy new format
  • Distribute tasks to update docs or add new docs as needed
• User guides etc
  • defining the user profiles and scope of the guides
• RPC/CLI etc docs (CLI docs autogenerated)
  • CLI Auto-generate CLI docs #4227
• Ensure sufficient analytics to understand what pages people are using and how they are finding them

Other improvements

• Update project README #2118
• chainsafe.io sub-domain for documentation #3758
• Don't deploy Rust docs to GH pages #3731
• Document common use-case examples #3109
• shell completion for forest and forest-cli #2602
• Update instructions on setting linux swappiness parameter #2563
• Document setting up metrics and monitoring  #1263

Other information and links

Sources of inspiration

https://docs.nethermind.io/
https://besu.hyperledger.org/
https://erigon.gitbook.io/erigon
https://geth.ethereum.org/docs

[ansermino]

Remaining issues will be tracked independantly