-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Consolidate documentation on docs.rs #3431
Copy link
Copy link
Open
Labels
S - docsAwareness, docs, examples, etc.Awareness, docs, examples, etc.S - metaProject governanceProject governance
Description
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.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
S - docsAwareness, docs, examples, etc.Awareness, docs, examples, etc.S - metaProject governanceProject governance