Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Revamp and Expand Pathfinder Documentation #2473

Open
wants to merge 8 commits into
base: main
Choose a base branch
from

Conversation

TropicolX
Copy link

@TropicolX TropicolX commented Jan 9, 2025

This PR introduces a thorough overhaul of the Pathfinder documentation using Docusaurus.

Live demo

localhost_3001_

Key highlights include:

  1. Introduction & Getting Started

    • Clear guidance on hardware requirements, Docker usage, and building from source.
    • Detailed instructions for verifying a node is properly configured and running.
  2. Interfacing with Pathfinder

    • Updated examples for JSON-RPC and WebSocket endpoints.
  3. Database Snapshots

    • Streamlined steps for using Rclone or HTTPS to download snapshots.
    • Verification steps for checksums and recommendations for snapshot usage.
  4. Monitoring API

    • Explanation of /health, /ready, and /ready/synced endpoints, plus /metrics for Prometheus integration.
  5. FAQ Section

    • Frequently asked questions about upgrades, network switching, and security considerations.
  6. Configuration Updates

    • Clarification of valid --network values (mainnet, sepolia-testnet, sepolia-integration, custom).
    • Examples for mixing command-line arguments and environment variables, highlighting PATHFINDER_ prefixed variables.
    • Logging and state trie pruning (archive vs k) explained with Docker and source-based setups.

Why This is Needed

  • Provides a single, comprehensive resource for both new and experienced users of Pathfinder.
  • Aligns documentation with the latest codebase defaults and newly added features.
  • Reduces confusion and GitHub Issues related to misconfiguration or incomplete instructions.
  • Docusaurus structure improves navigation and future maintainability.

Scope of Impact

  • Changes affect only documentation files within the Docusaurus configuration and content directories.
  • No breaking changes to the codebase itself.

Please let me know if you have any further suggestions or if additional changes are necessary.
Thank you for reviewing this PR!

@TropicolX TropicolX requested a review from a team as a code owner January 9, 2025 12:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant