search

VzBoT3D / docs

VzBot Documentation
https://docs.vzbot.org/
13 stars 23 forks source link

Fix layout + cleanup #77

Closed ZeroGDesign closed 1 year ago

ZeroGDesign commented 1 year ago

Fixing the Just the Docs layout,

Removing a ton of files that are included in just the docs and don't need to be there seperate (causing issues).

Installed the new logo + fav icon.

HumbleDeer commented 1 year ago

Hi!

Could you please clarify the reason for removing a plugin I recently intentionally added?

Can you clarify what was wrong in the layout? Did it have to do with the update to Just The Docs 0.6, and if so, does reverting to version 0.4 fix this?

I left out Faraday in the past, as its features didn't seem to pose a benefit for building in the GH runners. Can you explain what adding it back again does better?

I generally don't regularly update the gemlock, because the minor updates to many of the libraries don't really project any improvement and would merely end up clogging our git history. I update it when I am changing something else in the gemfile. :)

Thanks for your contributions!

ZeroGDesign commented 1 year ago

No problem:

Could you please clarify the reason for removing a plugin I recently intentionally added?

As far as I can see the plugin isn't being used.

Can you clarify what was wrong in the layout? Did it have to do with the update to Just The Docs 0.6, and if so, does reverting to version 0.4 fix this?

Sure, the initial layout was missing a lot of css/scss classes. This caused the layout to not display properly and not scale properly. Here is an example on how it should look We're not reverting the layout to an older version at all. The new version has loads of new features and fixes that are very nice.

I generally don't regularly update the gemlock, because the minor updates to many of the libraries don't really project any improvement and would merely end up clogging our git history. I update it when I am changing something else in the gemfile. :)

it seems that the Gemfile.lock was still displaying just-the-docs (0.4.2) indicating it wasn't updated with the layout, this doesn't seem like a minor update. Updating the gemfile using the bundle install command will grab your file Gemfile and install everything that is needed updating the Gemfile.lock to a newer version. I wouldn't worry to much about small changes either. But this is the main reason for the change.

Faraday

Was in your Gemfile already, just updated it. To my knowledge is used to run your local copy of jekyll/just the docs on your desktop so you can simulate it before you upload it to the Github Pages.

HumbleDeer commented 1 year ago

Do you have an image of what the broken layout was like? The image you included shows a layout identical or at least very close to what I've always seen. If something broke when I updated to just the docs 0.6 then that would be good to know :)

The plugin that seemed unused was being used in a file I was working on locally. I can't show an example of those as I'm currently away from my computer.

What's up with the pr being closed or the head deleted? Are there issues with the PR you made? Or was it a mistake? If there's any problem I can help sort out, do let me know!

Edit: just to clarify in case I'm not expressing it correctly; I'm not meaning to be condescending or demeaning. I simply want to have done my due diligence as to not simply approve pull requests without knowing what's in them, what the person intended, or what could be accidentally wrong. 😅

Cheers, HumbleDeer.

ZeroGDesign commented 1 year ago

Do you have an image of what the broken layout was like? The image you included shows a layout identical or at least very close to what I've always seen. If something broke when I updated to just the docs 0.6 then that would be good to know :)

The layout being broken isn't your fault, neither is the update to 0.6. It's the initial setup that is wrong. Adding the scss files to the folder itself makes jekyll not care for a external layout. This caused issues because there are many classes missing.

Here is a screenshot with a small explanation:

vs proper scaling

The plugin that seemed unused was being used in a file I was working on locally. I can't show an example of those as I'm currently away from my computer.

Then my removal of this plugin would be incorrect and it would definitely need to stay

What's up with the pr being closed or the head deleted? Are there issues with the PR you made? Or was it a mistake? If there's any problem I can help sort out, do let me know!

It's because I didn't want to leave it open as a fork on my profile as this profile is used for the ZeroG Project. if you want to check that out and see how we do it, it's on docs.zerog.one

HumbleDeer commented 1 year ago

I see, thanks for elaborating! And thanks for your contributions. :)

I'm on my way home now, and will be taking a look at my computer.

Thanks, HumbleDeer

On Sun, 17 Sep 2023, 3:24 am ZeroG, @.***> wrote:

Do you have an image of what the broken layout was like? The image you included shows a layout identical or at least very close to what I've always seen. If something broke when I updated to just the docs 0.6 then that would be good to know :)

The layout being broken isn't your fault, neither is the update to 0.6. It's the initial setup that is wrong. Adding the scss files to the folder itself makes jekyll not care for a external layout. This caused issues because there are many classes missing.

Here is a screenshot with a small explanation:

https://camo.githubusercontent.com/cab1cdd63860cbb83e028783642821029fb034a6bc966a5e83c7929672b8f73a/68747470733a2f2f692e696d6775722e636f6d2f536277626c55362e706e67

https://camo.githubusercontent.com/57fc36bc017f2f0f01dfdda84e5a93a3798a0ac3b7d922b78250668995cfedb7/68747470733a2f2f692e696d6775722e636f6d2f414364325763672e6a706567 vs proper scaling

https://camo.githubusercontent.com/7caf9b26c9d868800d42acbb1e792ef65a6f9aafcc1c1e92353854bfe14ddebf/68747470733a2f2f692e696d6775722e636f6d2f346f314e50656d2e706e67

The plugin that seemed unused was being used in a file I was working on locally. I can't show an example of those as I'm currently away from my computer.

Then my removal of this plugin would be incorrect and it would definitely need keeping.

What's up with the pr being closed or the head deleted? Are there issues with the PR you made? Or was it a mistake? If there's any problem I can help sort out, do let me know!

It's because I didn't want to leave it open as a fork on my profile as this profile is used for the ZeroG Project. if you want to check that out and see how we do it, it's on docs.zerog.one

— Reply to this email directly, view it on GitHub https://github.com/VzBoT3D/docs/pull/77#issuecomment-1722360739, or unsubscribe https://github.com/notifications/unsubscribe-auth/AD32W6BHNGAHTC7KLTYR6WTX2ZGLRANCNFSM6AAAAAA426TI7I . You are receiving this because your review was requested.Message ID: @.***>