reth icon indicating copy to clipboard operation
reth copied to clipboard

doc: add reth logo to docs

Open leovct opened this issue 2 years ago • 5 comments

Closes #3301.

I used the following URL for the logo: https://avatars0.githubusercontent.com/u/97369466. edit: I couldn't find Reth logo URL so I went with Paradigm instead

find crates -type f -name 'lib.rs' -exec sh -c 'grep -q "#![cfg_attr(docsrs, feature(doc_cfg))]" "{}"; if [ $? -ne 0 ]; then echo "#![cfg_attr(docsrs, feature(doc_cfg))]\n#![doc(\n    html_logo_url = \"https://avatars0.githubusercontent.com/u/97369466?s=128\",\n    html_favicon_url = \"https://avatars0.githubusercontent.com/u/97369466?s=256\",\n    issue_tracker_base_url = \"https://github.com/paradigmxzy/reth/issues/\"\n)]" | cat - "{}" > /tmp/tempfile && mv /tmp/tempfile "{}"; fi' \;

leovct avatar Jun 22 '23 08:06 leovct

this PR adds paradigm logo, we'd prob want reth's instead cc @gakonst

rkrasiuk avatar Jun 22 '23 09:06 rkrasiuk

this PR adds paradigm logo, we'd prob want reth's instead cc @gakonst

Yes, I couldn't find the Reth logo in the repo (maybe this? https://github.com/paradigmxyz/reth/blob/main/assets/reth.jpg) so I went with Paradigm logo instead. I can make the change if there's a URL that points to the Reth logo :)

leovct avatar Jun 22 '23 09:06 leovct

Codecov Report

Merging #3317 (3d23eb5) into main (1d3bab6) will decrease coverage by 0.37%. The diff coverage is 100.00%.

@@            Coverage Diff             @@
##             main    #3317      +/-   ##
==========================================
- Coverage   69.76%   69.39%   -0.37%     
==========================================
  Files         531      537       +6     
  Lines       71669    71991     +322     
==========================================
- Hits        49997    49960      -37     
- Misses      21672    22031     +359     
Flag Coverage Δ
integration-tests 16.34% <0.00%> (-0.03%) :arrow_down:
unit-tests 64.44% <100.00%> (-0.38%) :arrow_down:

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
crates/blockchain-tree/src/lib.rs 100.00% <100.00%> (ø)
crates/config/src/lib.rs 100.00% <100.00%> (ø)
crates/consensus/auto-seal/src/lib.rs 0.88% <100.00%> (ø)
crates/consensus/beacon/src/lib.rs 100.00% <100.00%> (ø)
crates/consensus/common/src/lib.rs 100.00% <100.00%> (ø)
crates/interfaces/src/lib.rs 100.00% <100.00%> (ø)
crates/metrics/metrics-derive/src/lib.rs 100.00% <100.00%> (ø)
crates/metrics/src/lib.rs 100.00% <100.00%> (ø)
crates/net/common/src/lib.rs 100.00% <100.00%> (ø)
crates/net/discv4/src/lib.rs 65.62% <100.00%> (-0.07%) :arrow_down:
... and 34 more

... and 66 files with indirect coverage changes

codecov[bot] avatar Jun 22 '23 09:06 codecov[bot]

@leovct roger. let's wait for @gakonst to chime in

rkrasiuk avatar Jun 22 '23 10:06 rkrasiuk

we have this https://github.com/paradigmxyz/reth/blob/main/assets/reth-alpha.png but I feel like this ratio is not ideal for docs image because it will be rendered like this for example:

https://docs.rs/tracing/latest/tracing/

So I think we need another image with just the logo and a favicon of it

mattsse avatar Jun 22 '23 14:06 mattsse

Marked as blocked since we need an image with a better aspect ratio (100x100)

onbjerg avatar Jun 25 '23 13:06 onbjerg

:+1: crop + downscale

gakonst avatar Jun 26 '23 15:06 gakonst

Screenshot from 2023-06-26 17-10-28

This is what it looks like

onbjerg avatar Jun 26 '23 15:06 onbjerg