Skip to content

Consolidate documentation on docs.rs #3431

@madsmtm

Description

@madsmtm

There is no clear guidelines in the Rust community on what goes in the README, and what goes on docs.rs. I read Ed Page's blog post on winnow a while back, and the idea of moving everything to docs.rs really resonates with me. I'll copy the core points below.

When exploring documentation options in clap, we found:

  • A lot of users want one place to go
  • Github is a poor place to store documentation because people naturally look at main and not the version pertinent to them

So a proposal: Let's move the scattered docs we do have from README.md and FEATURES.md to docs.rs.

Metadata

Metadata

Assignees

No one assigned

    Labels

    S - docsAwareness, docs, examples, etc.S - metaProject governance

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions