Skip to content

Improve documentation for introspect #420

@tbenst

Description

@tbenst

Introspec seems really neat, but the current documentation isn't sufficient to understand the "why" of the tool, or how/when it is useful. Perhaps a few sentences explaining the "decoder ring" would help? Right now, I can understand the syntax, which seems to show how to draw the output of introspect, but that doesn't exactly explain the purpose / utility.

It also introduces a nifty table struct, which doesn't have any documentation--I'll open a new issue for that

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