Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Consolidate documentation on docs.rs #3431

Open
madsmtm opened this issue Jan 27, 2024 · 2 comments
Open

Consolidate documentation on docs.rs #3431

madsmtm opened this issue Jan 27, 2024 · 2 comments
Labels
S - docs Awareness, docs, examples, etc. S - meta Project governance

Comments

@madsmtm
Copy link
Member

madsmtm commented Jan 27, 2024

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.

@madsmtm madsmtm added S - docs Awareness, docs, examples, etc. S - meta Project governance labels Jan 27, 2024
@madsmtm
Copy link
Member Author

madsmtm commented Jan 27, 2024

Related proposal, since we're cleaning things up anyhow: Remove the Testers and Contributors table (and disable the wiki), the table is outdated, and I've at least personally never used it myself (though of course it's basically empty for the backends I maintain, so I guess I wouldn't really have a say here).

@daxpedda
Copy link
Member

I agree that the Wiki should be removed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S - docs Awareness, docs, examples, etc. S - meta Project governance
Development

No branches or pull requests

2 participants