Skip to content

[Task]: Use crate README's as crate's top level inline documentation #1171

@Javagedes

Description

@Javagedes

Feature Overview

It was noted that the README for some of our crates can easily become outdated as it is not tested in anyway (mainly the examples provided). We need to ensure that the crate's readme stays up to date as the readme is what is published to crates.io.

Solution Overview

Update each of the crates such that the crate's README.md, which is used as the readme for crates.io web page, is imported as the crate's top level inline documentation. This ensures that the two stay in sync, but also that any examples are always up to date.

Alternatives Considered

No response

Urgency

Medium

Are you going to implement the feature request?

I will implement the feature

Do you need maintainer feedback?

No maintainer feedback needed

Anything else?

No response

Metadata

Metadata

Assignees

Labels

Type

Projects

Status

No status

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions