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

Use lib docstring as crates.io README #470

Merged
merged 1 commit into from
Oct 18, 2024

Conversation

djmitche
Copy link
Collaborator

This makes https://crates.io/crates/taskchampion and https://docs.rs/taskchampion/ display (roughly) the same information. The symbol links like [`Replica`] won't work on on crates.io but I think that's OK (I've certainly seen it on other crates).

Copy link
Collaborator

@ryneeverett ryneeverett left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems like a good tradeoff to me. I'm not sure I'd ever even looked at the crates.io website before just now (for any project, let alone taskchampion).

@djmitche djmitche merged commit c5bb092 into GothenburgBitFactory:main Oct 18, 2024
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants