[Docs] Simplify / Prepare for Beta TestNet onboarding

[okdas]

Objective

Expand existing poktroll/path documentation to cover all actors, providing clear, user-friendly guidance for network participants.

Origin Document

We need to expand the existing documentation to support new users. The goal is to make the documentation thorough and accessible for participants with varying levels of experience.

Goals

• Ensure all new network actors are thoroughly documented.
• Provide clear, actionable documentation for common tasks (e.g., installation, maintenance) for each actor.
• Make the documentation approachable and easy to follow for new and existing users.
• Maintain consistency with Cosmos SDK documentation, linking where applicable to avoid redundancy.

Deliverables

• Validator/FullNode Documentation:

  • Installation: Detailed guide on setting up a Validator node, including dependencies.
  • Maintenance: Instructions on regular updates, upgrades, and common maintenance tasks (see [Docs] Document common supplier/node maintainer operations: pruning, snapshots & rollbacks #753).
  • Staking: Steps to stake and manage staking operations ([Docs] Document and make a playbook on how to stake validators #754).
  • Observability: Guidance on monitoring metrics, setting alerts, and best practices.
  • Troubleshooting: Common issues and solutions for Validator nodes.

• PATH Documentation:

  • Installation: Complete setup instructions specific to PATH nodes.
  • Maintenance: Procedures for updating, upgrading, and maintaining PATH nodes.
  • Staking: Overview of staking mechanisms for PATH nodes.
  • Observability: Key metrics, logs, and monitoring practices.
  • Troubleshooting: Common Path node issues with solutions.

• RelayMiner Documentation:

  • Installation: Step-by-step instructions for RelayMiner setup and configuration.
  • Maintenance: Details on upgrades, maintenance, and optimization.
  • Staking: How to manage staking for RelayMiner.
  • Observability: Metrics, alerts, and logs for monitoring performance.
  • Troubleshooting: Solutions for frequently encountered issues with RelayMiner nodes.

• General Documentation Requirements:

  • Link to relevant Cosmos SDK documentation where applicable to avoid duplication.
  • Ensure examples, configuration snippets, and commands are provided where relevant.
  • Conduct user testing or gather feedback from new users to confirm documentation is easy to follow.
  • Deploy completed documentation to https://dev.poktroll.com/.

Non-goals / Non-deliverables

• Do not create entirely new tools or alter existing Cosmos SDK tools beyond documentation.
• Avoid overly technical or niche explanations that may hinder accessibility for new users.
• Do not duplicate Cosmos SDK content that can be directly referenced.

---

Creator: @okdas