Polkadot-Blockchain-Academy / pba-content

An intensive academic program teaching Blockchain, Substrate, and Polkadot.
https://polkadot-blockchain-academy.github.io/pba-content/
MIT License
56 stars 27 forks source link

Remove per-module style in favor of global style #773

Open nuke-web3 opened 1 year ago

nuke-web3 commented 1 year ago
          We want to _remove_ per-module style in favor of global only style, with tweaks for specific elements via tailwind and/or other plugins.

@wirednkod wdyt about this globally? I think someone wanted the opposite earlier... @BradleyOlson64 IIRC

_Originally posted by @NukeManDan in https://github.com/Polkadot-Blockchain-Academy/pba-content/pull/772#discussion_r1274287645_

shawntabrizi commented 1 year ago

This is such an arbitrary requirement.

Stylized CSS elements is a huge part of any web design.

I don't understand what you are trying to gain by limiting the ability to customize elements.

nuke-web3 commented 1 year ago

I get that it is constricting the true unlimited pallet we have to use CSS that indeed you are adept in, more than most content creators for the PBA :magic_wand: But we are not making a website.

We are making a set of documentation for learning from, perhaps also expanding into some MVP for a custom LMS like Canvas you may have used before. The web analog perhaps best is MySpace vs Facebook: we lean into an intentionally restricted set of styles and abilities for the content creator (like Facebook) for many reasons, here are a few key ones:

wirednkod commented 1 year ago

In providing my perspective, I believe that incorporating a global outlook into the slides is appropriate as it maintains uniformity. Simultaneously, it is essential not to restrict the presenter's ability to customize the lecture slides according to their preferences, as long as it aligns with the overall guidelines.

While I don't advocate for extreme deviations from the original approach, it is crucial to acknowledge that exceptions can exist. I respectfully disagree with some of the points raised, and I shall elucidate my reasons:

In conclusion, it is beneficial for presenters to infuse their ideas into the slides, both in terms of content and style. Such individual contributions may even evolve into established conventions over time. Therefore, we should strike a balance by offering limited customizability while providing helpful tools to facilitate usage, such as mermaid, d3 charts, and tailwind, for instance.

shawntabrizi commented 1 year ago

End of the day, there are a bunch of styles applied across the slides, which really dont make sense in a lot of contexts.

I mean, the CSS that brought up this thread was to fix an already opinionated way of having bullet points.

Let's compare the look of the two.

Before:

image

After:

image

Look at how stupid the padding / margin looks on these bullets in the context of this slide. Would you ever NOT customize the styling here?

Please look at the custom CSS file:

https://github.com/Polkadot-Blockchain-Academy/pba-content/blob/main/assets/styles/custom-classes.css

Is there really anything in there which is rocket science? If we have anyone in the academy (student or lecturer) who cannot figure out these styles, they should probably not be here.

Also note that all of these styles are written to be reusable OR specific to a niche diagram / slide.

Installing tailwind does give access to some more tools, but does NOT act as a solution for styling, nor is it really any more efficient or easy to understand.

Whatever your mental model is of the bad-ness of custom CSS needs to be adjusted, and you should rely on people's judgement who have much more experience using these tools.

wirednkod commented 1 year ago

Concerning tailwindcss, i would agree and add, that the only thing, that I can say it adds as value, is adding simple customization inside the md/html (className), instead of creating a