Skip to content

Add Example for 'Pruning' Feature in Class Hierarchy Visualization #26

@nonameebyrator985

Description

@nonameebyrator985

Issue Description

The README documentation mentions a pruning feature for the class hierarchy visualization, which allows users to reduce the size of the tree based on specific keywords. However, there are no examples demonstrating how to use this feature in practice.

Suggested Improvements

It would be beneficial to include a detailed example in the README that shows how to format the URL correctly when using the prune parameter. Here’s a proposed addition:

Example Usage for Pruning

Here’s how you can prune the hierarchy to only include relevant nodes:

  1. Open your browser and go to http://localhost:7090/?class=androidx.fragment.app.Fragment&prune=YourKeyword.
  2. Replace YourKeyword with the appropriate keyword you wish to filter by.

This will help users quickly understand how to effectively utilize the pruning feature and enhance their experience with the tool.

Additional Notes

Consider adding a brief explanation of what constitutes a good keyword for pruning and perhaps link to a blog post or further documentation that elaborates on effective usage.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions