Skip to content

Ensure each package's README lists purpose and accurate usage examples #5742

Open
@mcmire

Description

@mcmire

Most of the packages in the core repo have a very spartan README. While this makes it easy to maintain, it is not very helpful for contributors.

Ideally, each package's README should describe its purpose and provide usage examples.

As a bonus, we should consider finding a way to make the usage examples executable, and run them in CI (similar to Rust's documentation tests).

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions