solid / solidproject.org

Website for solidproject.org
https://solidproject.org
MIT License
147 stars 101 forks source link

Refactor Redesign Code #836

Closed VirginiaBalseiro closed 5 months ago

VirginiaBalseiro commented 5 months ago

This PR is co-authored by @csarven .

This PR mainly covers refactoring the proposed code for the new website design, in order to simplify code and facilitate maintenance and contributions. It uses semantically correct HTML; removes CSS libraries and JavaScript.

Issues/Regressions

This is just a high-level summary and not an exhaustive list of issues or regressions. We were able to identify various areas where more attention and additional work is needed.

Notes on implementation

Just some linked data stuff of the documents here... no big deal:

image

csarven commented 5 months ago

Thanks for reviewing @KyraAssaad . I'll try to respond to your comments here, let me know how this sounds:

As you've noted, there can be more classes (or essentially any recurring selector). Thus far we tried to identify and markup common / recurring data patterns based on the proposed visual design, and a bit from the current website. But more work there is needed. And, to get there, more pages need to be marked up and/or refer to a (IA) document specifying the classifications. This will also ensure updating the information consistently with a (Solid) application, especially with the inclusion and help of RDFa.

In some places we tried to reuse patterns, and as you've also noted with things like details. Whether that structure and semantics remains or not depends on distilling the underlying data patterns. Either way, the CSS can take care of the default details (to be [open], and hiding summary) look whether it remains in the HTML or not, and the dts can be hidden from the visual representation. ul and dl is used quite a bit as it helps to maintain structure to significant units of information. It is also accessible to text-based web browsers. And, if/when a design needs to show any particular dt (for instance), only the CSS needs to change. The intention is to reuse the data patterns in HTML as much as possible throughout the pages (including new ones).

So, I think once the recurring data patterns are fine-tuned, it is easy to settle down the view.

timbl commented 5 months ago

Thank you for all this great work leaving the site declarative. I approve of the direction. I hope that we see this deployed soon. The the cost of having the old design up is significant I think and so switching to the new one before it is perfect may be optimal. The sooner we switch the sooner we get user feedback.