paritytech / polkadot-sdk-docs

_THE_ Polkadot SDK Tutorial
19 stars 0 forks source link

Tracking Issue for new graphics that we need better versions of. #8

Closed kianenigma closed 1 year ago

hummusonrails commented 1 year ago

I'm "assigning" this to Sacha, because he has some of the most experience auditing and running through the docs on our team. Can you create a list, output format I think is less important (google sheet, notion page, something on github) with a list of graphics currently being used on the docs and what needs in your opinion a refresh?

kianenigma commented 1 year ago

Yes, but bear in mind that the execution will be with Iggy.

For now, what I want to do is to re-design of the most important figures that we have in:

  1. PBA slides
  2. substrate docs
  3. polkadot wiki

One example of this is the famous "Technical Freedom vs Development Cost" spectrum. We have 6 versions of this, and half of them look really bad. We should have one reusable item for this.

One important note (to be discussed with Iggy) is that want the new graphic to be slick, representative and clear of the tech, but more importantly, neutral. This is because we are likely moving away from the substrate brand, and want to rely more on the Polkadot identity across the board.

For this, and various other reasons (eg reuse in PBA, which has its own brand), I am a big fan:

  1. Build everything white-labeled, without a strong brand identity.
  2. Make it easy to retrofit it: easily swap fonts, color themes and so on.

I am happy for @sacha-l to own this. The first task would be to identify eg 5 most common graphics that we use, and we don't have a good version of.

kianenigma commented 1 year ago

Another starting point is making a version of the landing page that I described here and putting it in #6, ie as a temp replacement of aritytech.github.io.

Although I think marcomms might want the same someday as well for the Polkadot website, but I have agreed with ChrissB from marcomms to be in touch with Iggy and align.

sacha-l commented 1 year ago

This was a list I jotted down of diagrams that sorely need some love:

Priority:

Less top-priority:

Note: new versions on these should be SVGs so we can handle dark mode.

kianenigma commented 1 year ago

As things evolved, we mostly use mermaid.