Skip to content

Add Advanced Transactions Filter documentation to Rootstock Explorer.#486

Open
carlos-rsk wants to merge 2 commits intomainfrom
feat/DX-1752-explorer-docs-how-to-filter-transactions
Open

Add Advanced Transactions Filter documentation to Rootstock Explorer.#486
carlos-rsk wants to merge 2 commits intomainfrom
feat/DX-1752-explorer-docs-how-to-filter-transactions

Conversation

@carlos-rsk
Copy link
Contributor

@carlos-rsk carlos-rsk commented Mar 24, 2026

Title: Advanced Transactions Filter guide

Description

Adds a new documentation article to the Rootstock Developers Portal explaining how to use the Advanced Transactions Filter on the Transactions page in the Rootstock Explorer.

The guide is part of the Explorer educational tutorial series and is designed to help developers and users efficiently search and analyze transaction activity on the Rootstock network.

What’s included

  • Overview of the Transactions page

  • Explanation of why transaction filtering is useful

  • Detailed breakdown of all available filter options:

    • Transaction Type (Remasc, Bridge, Normal, Contract Deploy, Contract Call)
    • Status
    • Block (single and range)
    • Date (single and range)
    • From / To Address
    • Address Logic (AND / OR)
  • Step-by-step instructions on how to use the Advanced Filter

  • Practical examples demonstrating how to combine filters

  • Placeholder sections for screenshots/UI references

Goal

Provide a clear, tutorial-style guide that enables users to quickly locate and analyze specific transactions using advanced filtering capabilities.

@vercel
Copy link

vercel bot commented Mar 24, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
devportal-rootstock Ready Ready Preview, Comment Mar 24, 2026 3:49pm

Request Review

@github-actions
Copy link
Contributor

github-actions bot commented Mar 24, 2026

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Snapshot Warnings

⚠️: No snapshots were found for the head SHA bc362b7.
Ensure that dependencies are being submitted on PR branches and consider enabling retry-on-snapshot-warnings. See the documentation for more information and troubleshooting advice.

OpenSSF Scorecard

PackageVersionScoreDetails

Scanned Files

@github-actions
Copy link
Contributor

🔗 Broken Links/Anchors Found in en

The build found broken internal links or anchors.

🔗 Broken Links
- Broken link on source page path = /dev-tools/:
   -> linking to /resources/guides/superbridge/
⚓ Broken Anchors


How to fix:

  1. Check if the linked page exists
  2. Update the link to the correct URL
  3. If the page was moved, update to the new location
  4. If the page was deleted, remove the link
  5. For anchors, verify the heading ID exists on the target page

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds a new guide to the Rootstock Explorer documentation describing how to use the Advanced Transactions Filter, and links it from the explorer docs index so users can discover it.

Changes:

  • Added a new “Advanced Transactions Filter” documentation page with step-by-step instructions and examples.
  • Added a new card/link entry on the Rootstock Explorer docs landing page pointing to the new guide.

Reviewed changes

Copilot reviewed 2 out of 15 changed files in this pull request and generated 3 comments.

File Description
docs/05-dev-tools/explorers/rootstock-explorer/index.md Adds a new FilterItem linking to the Advanced Transactions Filter guide.
docs/05-dev-tools/explorers/rootstock-explorer/advanced-transactions-filter.md New guide detailing filter fields, usage steps, and practical examples with screenshots.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@owans
Copy link
Collaborator

owans commented Mar 24, 2026

This documentation set provides a clear and helpful guide for using the Advanced Transactions Filter in the Rootstock Explorer, and an organized index page. The content is well-structured, easy to follow, and includes practical examples that improve user understanding.

The language used is generally precise and follows active voice, which is excellent for technical documentation. The visual aids (screenshots) are well-placed and annotated with appropriate alt text, which greatly improves clarity.

There are minor areas for improvement, primarily about stylistic consistency, phrasing for best readability, and a small internal note in the index file. These adjustments will further refine the quality and professionalism of the documentation.

Review: docs/05-dev-tools/explorers/rootstock-explorer/advanced-transactions-filter.md

This document is a well-structured and practical guide to using the Advanced Transactions Filter. It effectively breaks down a complex feature into manageable sections, making it accessible to users who need to analyze blockchain transactions.

Grammar and language:

  • Generally strong, with good use of active voice and clear sentence structures.
  • Minor grammatical precision could be improved in a few spots.

Style and tone:

  • Consistent, informative, and helpful tone. It maintains an imperative mood for instructions, which is appropriate for a how-to guide.

Clarity and readability:

  • Excellent clarity. The step-by-step instructions and filter option descriptions are easy to understand.
  • The "Why Use Transaction Filtering?" section effectively sets the context.
  • Practical examples are a key strength, showing filter combinations clearly.

Docs:

  • The instructions are clear and sequential.
  • Prerequisites are implied (access to Rootstock Explorer), which is reasonable.
  • Terminology is consistent throughout the document.

Tutorials:

  • The step-by-step guide is precise, and the examples are reproducible.
  • Assumptions are minimal and appropriate for the target audience.

Structure and organization:

  • The heading hierarchy is logical and easy to navigate.
  • Paragraphs flow well, and the information is presented in a logical order, moving from an overview to detailed options and practical applications.

Consistency:

  • Terminology (e.g., "From address," "To address") is consistently capitalized.
  • Formatting for lists and headings is consistent.

Audience appropriateness:

  • The language and technical depth are suitable for developers and advanced users who need to perform detailed transaction analysis. Explanations of transaction types (Remasc, Bridge) are helpful for this audience.

Completeness:

  • The guide feels complete for its stated purpose. It covers all aspects of the advanced filter and provides relevant use cases.
  • The "Related guides" section is a good addition for further learning.

Code snippets:

  • No actual code snippets are present, but values like 100, 200, 300 or from block 100 to 200 would be clearer with inline code formatting for better visual distinction, as is common in documentation.

Specific findings and recommendations for advanced-transactions-filter.md

  1. Line 22: "Exact control labels may match the screenshots you add to this page."

    • Comment: This sentence seems like an internal note for the documentation author rather than information for the reader. It could be removed or rephrased if it intends to convey something to the user.
    • Suggestion: Consider removing this sentence as it reads as an internal instruction. If the intent is to warn users about potential UI variations, a more direct phrasing for users would be: "The labels for these controls may vary slightly depending on the Explorer's UI version, but their functionality remains consistent with the descriptions provided."
  2. Line 27: "Remasc: Rootstock reward and fee distribution transactions produced by the network."

    • Comment: The phrase "produced by the network" is slightly redundant and could be streamlined for conciseness.
    • Suggestion: "Remasc: Rootstock reward and fee distribution transactions."
  3. Line 36: "Status filters by execution outcome."

    • Comment: This sentence lacks a subject or reads awkwardly as a heading description. Adding a colon after "Status" or rephrasing would improve clarity and align with the style of other definitions.
    • Suggestion: "Status: Filters by execution outcome."
  4. Lines 40, 43: Block numbers 100, 200, 300 and from block 100 to 200

    • Comment: For consistency and better visual parsing in technical documentation, literal values like block numbers should ideally be formatted as inline code.
    • Suggestion:
      • Line 40: "Specific blocks to match one block, or enter several block numbers separated by commas (for example, 100, 200, 300) to match transactions in any of those blocks."
      • Line 43: "Range blocks: Define a start and end block (for example, from block 100 to 200)."
  5. Line 47: "Choose an audit window preset to limit results to recent activity:"

    • Comment: The phrasing "audit window preset" feels slightly informal. "Predefined audit window" or "preset date range" might be clearer.
    • Suggestion: "Choose a predefined audit window to limit results to recent activity:"

Review: docs/05-dev-tools/explorers/rootstock-explorer/index.md

This index.md file is an effective landing page for the Rootstock Explorer documentation. It uses an MDX <Filter> component to show a clear, easy-to-navigate overview of related guides.

Grammar and language:

  • The descriptions for each FilterItem are concise and grammatically correct.

Style and tone:

  • Professional and informative, consistent with a documentation hub.

Clarity and readability:

  • The Filter component clearly organizes related articles, making it very easy for users to find what they need.
  • Descriptions are brief but informative.

Docs:

  • Effectively links to relevant guides within the explorer section.
  • The structure using FilterItem is good for discoverability.

Structure and organization:

  • The use of MDX for filtering content is an excellent way to organize a collection of guides.
  • The heading and sidebar labels are clear.

Consistency:

  • Consistent in its use of the FilterItem component and its properties (title, subtitle, description, links).

Audience appropriateness:

  • Appropriate for developers and users looking for specific information related to the Rootstock Explorer.

Completeness:

  • As an index, it is complete in listing key guides for the explorer.

Code snippets:

  • The file contains a commented-out section within the MDX code block.

Specific findings and recommendations for index.md

  1. Lines 9-12: Commented-out FilterItem definitions.
    • Comment: The commented-out section (/* {{label: 'dApp & Ecosystem', value: 'dapps'}, {label: 'Debugging & Advanced', value: 'debug'}, {label: 'Cross Chain', value: 'cc'} } */) is present within the MDX code block. While comments are generally fine, these specific comments look like internal development notes that are not intended for the end-user reading the markdown source. For clarity and a clean source file, these should ideally be removed if they are not active or intended for rendering.
    • Suggestion: Remove the commented-out section:
      - /* {{label: 'dApp & Ecosystem', value: 'dapps'},
      - {label: 'Debugging & Advanced', value: 'debug'},
      - {label: 'Cross Chain', value: 'cc'} } */
      ]>

💬 Comment posted via Revue - Documentation Review Tool

@github-actions
Copy link
Contributor

🔗 Broken Links/Anchors Found in en

The build found broken internal links or anchors.

🔗 Broken Links
- Broken link on source page path = /dev-tools/:
   -> linking to /resources/guides/superbridge/
⚓ Broken Anchors


How to fix:

  1. Check if the linked page exists
  2. Update the link to the correct URL
  3. If the page was moved, update to the new location
  4. If the page was deleted, remove the link
  5. For anchors, verify the heading ID exists on the target page

Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 2 out of 15 changed files in this pull request and generated 2 comments.


💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment on lines +70 to +72
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/tx-specific-block.png" alt="Advanced Transactions Filter: Specific Block"/></div>
- **Range blocks**: Define a start and end block (for example, from block 100 to 200).
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/range-blocks.png" alt="Advanced Transactions Filter: Range Blocks"/></div>
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The <div><img/></div> blocks between these two bullet points will likely break the Markdown list into multiple separate lists (the image won’t be nested under the intended list item unless it’s indented as part of the list). Consider indenting the image blocks so each screenshot is clearly associated with its bullet, or convert each bullet + image into its own subheading/paragraph structure.

Suggested change
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/tx-specific-block.png" alt="Advanced Transactions Filter: Specific Block"/></div>
- **Range blocks**: Define a start and end block (for example, from block 100 to 200).
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/range-blocks.png" alt="Advanced Transactions Filter: Range Blocks"/></div>
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/tx-specific-block.png" alt="Advanced Transactions Filter: Specific Block"/></div>
- **Range blocks**: Define a start and end block (for example, from block 100 to 200).
<div align="center"><img width="100%" src="/img/tools/explorer/rootstock/txs/range-blocks.png" alt="Advanced Transactions Filter: Range Blocks"/></div>

Copilot uses AI. Check for mistakes.

Filters by execution outcome. You can choose **Success** or **Failed**.

- **Success:** The transaction was included in a block and executed without revert.
Copy link

Copilot AI Mar 24, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Minor grammar: “executed without revert” reads awkwardly; consider rephrasing to “executed successfully (did not revert)” or “executed without reverting” for clarity.

Suggested change
- **Success:** The transaction was included in a block and executed without revert.
- **Success:** The transaction was included in a block and executed successfully (did not revert).

Copilot uses AI. Check for mistakes.
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.

3 participants