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.

Sign up for GitHub

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

Jump to bottom

[CI] Generate READMEs from crate docs #2930

Open
ggwpez opened this issue Jan 15, 2024 · 2 comments
Open

[CI] Generate READMEs from crate docs #2930

ggwpez opened this issue Jan 15, 2024 · 2 comments
Labels
D1-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase. I5-enhancement An additional feature request.

Comments

@ggwpez
Copy link
Member

ggwpez commented Jan 15, 2024

Most of our crates have no/outdated/insufficient READMEs on crates-io. Now instead of trying to replicate the crate docs in the README and rust doc, we can used cargo-readme to generate a README file from the crate package doc.

I think we should set up a CI check that verifies that all README files that exist are either auto generated or whitelisted as "manually maintained" in some config file. The second option would only be a intermediate™ solution.
@nuke-web3
Copy link
Contributor

Related or duplicate of #1260 ?

@nuke-web3 nuke-web3 mentioned this issue Jan 18, 2024
Closed
@ggwpez ggwpez added C1-mentor A task where a mentor is available. Please indicate in the issue who the mentor could be. D1-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase. I5-enhancement An additional feature request. labels Feb 5, 2024
@ggwpez
Copy link
Member Author

ggwpez commented Feb 5, 2024

Related or duplicate of #1260 ?

Not quite, we should still do that.

@ggwpez ggwpez removed the C1-mentor A task where a mentor is available. Please indicate in the issue who the mentor could be. label Aug 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
D1-medium Can be fixed by a coder with good Rust knowledge but little knowledge of the codebase. I5-enhancement An additional feature request.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@ggwpez @nuke-web3