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

The logo on docs.rs/defmt is missing #904

Open
jonathanpallant opened this issue Nov 29, 2024 · 5 comments
Open

The logo on docs.rs/defmt is missing #904

jonathanpallant opened this issue Nov 29, 2024 · 5 comments
Labels
good first issue Good for newcomers

Comments

@jonathanpallant
Copy link
Contributor

You just get a missing-image box at docs.rs/defmt.

@Urhengulas
Copy link
Member

I am pretty sure the logo was shown before, so I think it might be a problem on the docs.rs side as well.

@Urhengulas
Copy link
Member

It is not docs.rs fault, but because the logo was fetched from the knurling website which not available anymore.

@Urhengulas
Copy link
Member

Instead of relying on an external link the image should be included locally.

@Urhengulas Urhengulas added the good first issue Good for newcomers label Dec 2, 2024
@BenFordTytherington
Copy link
Contributor

After lots of searching, and reading this issue: rust-lang/rust#32104, I think using local images isn't possible / simple, and even by providing the url of the logo in the book folder I couldn't manage to render it with cargo doc --open

@Urhengulas
Copy link
Member

For me the logo shows when changing the link:

diff --git a/defmt/src/lib.rs b/defmt/src/lib.rs
index 605e96d..d4d4055 100644
--- a/defmt/src/lib.rs
+++ b/defmt/src/lib.rs
@@ -17,7 +17,7 @@
 
 #![cfg_attr(not(feature = "unstable-test"), no_std)]
 // NOTE if you change this URL you'll also need to update all other crates in this repo
-#![doc(html_logo_url = "https://knurling.ferrous-systems.com/knurling_logo_light_text.svg")]
+#![doc(html_logo_url = "https://defmt.ferrous-systems.com/assets/knurling_logo_light_text.svg")]
 #![warn(missing_docs)]
 
 #[cfg(feature = "alloc")]

Before:
Screenshot from 2024-12-19 16-29-33
After:
Screenshot from 2024-12-19 16-29-27

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants