search

ForkAwesome / Fork-Awesome

DEPRECATED. A fork of the iconic font and CSS toolkit
https://forkaweso.me
1.32k stars 142 forks source link

revamp website #345

Open shinenelson opened 3 years ago

shinenelson commented 3 years ago

The documentation website was last updated ( in terms of layout and structure ) as this fork was created. It requires a 'modernization' effort in updating the technology stack that runs the website.

The website currently runs using bootstrap-3.3.5 which has a hard dependency on jQuery ( which is on v1.11.3 ). Bootstrap version 5 eliminated the dependency on jQuery.

We need to upgrade the website's technology stack to be more 'modern'.

shinenelson commented 3 years ago

One personal wish is to eliminate bootstrap as a whole framework from the website. Jekyll supports including SASS and builds the website with the relevant styles applied.

The website does not use many components from Bootstrap. A quick run-through of the website indicates that there is the base, navbar, dropdown and the modal that is being used.

We could extract only the SASS portions that is required for the website and use them for the website. That way we could avoid one extra dependency for the website.

The disadvantage to 'extracting' anything from a different project is maintenance. We would have to commit to maintaining the extracted SASS rules as we go. It would be okay if we were going to create a hard-fork ( of sorts ) and then maintain it forward. But I do not think that would be necessary. What we should be committing to is to track upstream changes to the files that we 'extract' and then import them into the project on a regular basis. Otherwise, we will still be left behind like we are right now.

Bootstrap's SCSS is a directory within the main bootstrap project. We will probably have to explore using git subtree to keep track of upstream changes to Bootstrap's SCSS.

shinenelson commented 3 years ago

GitHub corners

JoaquinDecima commented 3 years ago

If you want you could try to do a redesign of the website (at least in terms of structure). But in my case I would prefer to update to Bootstrap 5 (Or failing that, change to another like METO or tailwind) and rearm the site. If you are interested at least to see how it looks, I could make a fork and start working on it and show you a redesign.

shinenelson commented 3 years ago

Thank you for the initiative @JoaquinDecima. It is much appreciated.

The reason that this has not been worked upon is because the current build system for the website is kind of complex to work with. So we are trying to modernize the existing build system and make it easier to build the website.

However, with that said, if you can manage to work with the existing build system and take up what you would like to get done, please do. We are here to support you if you are stuck.