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

Restore crate-level docs to lib #26

Merged
merged 1 commit into from
Jun 22, 2024
Merged

Restore crate-level docs to lib #26

merged 1 commit into from
Jun 22, 2024

Conversation

mycognosist
Copy link
Collaborator

As @AljoschaMeyer pointed out, direct cargo doc links do not work in the context of the README.

We'll duplicate the docs in the README and I'll update the links to point to the relevant docs.rs pages once the crate has been published.

@mycognosist mycognosist added the documentation Improvements or additions to documentation label Jun 21, 2024
@mycognosist mycognosist merged commit ef88da9 into main Jun 22, 2024
1 check failed
@mycognosist mycognosist deleted the duplicate_readme_docs branch June 22, 2024 08:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant