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

Include README and Dioxus logo in package docs #1536

Merged
merged 2 commits into from
Oct 10, 2023
Merged

Include README and Dioxus logo in package docs #1536

merged 2 commits into from
Oct 10, 2023

Conversation

tigerros
Copy link

Adds:

#![doc = include_str!("../README.md")]
#![doc(html_logo_url = "https://avatars.githubusercontent.com/u/79236386")]
#![doc(html_favicon_url = "https://avatars.githubusercontent.com/u/79236386")]

To most package lib.rss. Not sure if the README is desired, but I saw it in some packages and thought it was nice. I also noticed there was a good amount of rustdoc warnings when running cargo doc. Maybe we should include checking for rustdoc warnings in a workflow.

ealmloff
ealmloff requested changes Oct 10, 2023
View reviewed changes
packages/generational-box/README.md Outdated Show resolved Hide resolved
ealmloff
ealmloff approved these changes Oct 10, 2023
View reviewed changes
Copy link
Member

@ealmloff ealmloff left a comment

Choose a reason for hiding this comment

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

Thank you!

@ealmloff ealmloff merged commit 2d1234c into DioxusLabs:master Oct 10, 2023
10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ealmloff ealmloff ealmloff approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@tigerros @ealmloff