Updates include:
- Updated `explorer/README` quick start guide with instructions on starting an explorer environment (site + explorerd) in no-sync mode (skipping blockchain node connections)
- Updated `explorer/explorerd/README` quick start guide with details on running `explorerd` in no-sync mode
This update improves documentation usability by providing more context in the prerequisites section and adding step-by-step guidance for verifying a successful Explorer environment startup.
Summary of Updates:
- Refactored the prerequisites section for better clarity and organization
- Introduced a new "Confirming Successful Start" section with guidance on environment initialization
- Updated the Quick Start Guide overview paragraph
- Adjusted the Table of Contents to reflect the prerequisites refactor
This commit enhances the explorer README by updating the quick-start guide to work with new enhancements that automatically start node environments including installing missing dependencies. Additionally, it clarifies the current network status for testnet and mainnet environments.
Summary of Updates:
- Added Quick-Start Guide section to README documenting new make commands to start explorer environments
- Added Network Status section explaining the current placeholder state of testnet and mainnet
- Reorganized and updated the prerequisites section to reflect automatic building from source for missing node dependencies
- Added help command information (make help) for quick reference
- Updated table of contents to reflect new organization
Created the initial top-level README documentation for the DarkFi Blockchain Explorer, with the expectation of future refinements, updates to align with the latest UI design, and the addition of more details over time.
Summary of Updates:
- Introduced a project description, highlighting the Explorer’s purpose and core functionalities
- Added a Key Features section outlining the Explorer's capabilities
- Provided a Quick Start Guide with prerequisites, installation steps, and instructions for running on localnet
- Documented Explorer Components, including the explorer nodes and web interface
- Included a Configuration section covering configuration files and supported networks
- Detailed Feature Highlights, such as block exploration, gas analytics, and contract source navigation
- Integrated initial explorer screenshots to help with clarity and user guidance