faithful-resource-pack / docs Goto Github PK

What happened?

When making a new commit to this GitHub repository, the site automatically deploys and builds on our VPS. However, the images have not appeared to recompile in some months despite many of them changing. This results in outdated images even though they've been pushed to the repository.

To reproduce

1. Change an image on the GitHub repository.
2. Wait until the deployment has finished.
3. Check the docs site, and notice that the image has not updated, even after clearing cache, using a different browser, or even a different device.

Screenshot(s)

Notice how the image on the docs site hasn't updated despite a commit being made nearly six months ago.

Browser name and version

Multiple browsers (tested on Chrome, Firefox, and Brave).

Notes

May be related to this commit or this commit, both of which optimized build times.

Add a link to the API Docs?

What happened?

When accessing https://docs.faithfulpack.net/404, the footer is not transparent as it should be, and instead renders gray. I would have expected the footer to be transparent and blend in with the End background.

To reproduce

1. Go to https://docs.faithfulpack.net/404.
2. Scroll down.
3. See that the footer is not transparent.

Screenshot(s)

Browser name and version

• Brave Version 1.49.120, Chromium: 111.0.5563.64

Notes

Pretty low priority but figured I'd bring it up here anyways

What happened?

When using light mode on the docs site, the footer text remains white and is nearly invisible. It should instead change to black to match all other text.

To reproduce

1. Go to the docs site
2. Switch to light mode
3. Scroll down to the footer
4. Notice how the text remains white

Screenshot(s)

Browser name and version

Brave Version 1.50.121
Chromium: 112.0.5615.138 (Official Build) (x86_64)

Notes

No response

Problem

When using IDs such as in the table of contents on the docs site to find a specific entry (the texturing guidelines use this a lot), the screen doesn't move to the proper area and instead falls a bit short.

Expected Outcome

When using these URLs they move the screen down to the proper area.

Examples / How to reproduce

1. Navigate to the following URL: https://docs.faithfulpack.net/pages/textures/texturing-guidelines#credits
2. Notice how it doesn't actually move the screen to the credits section and stops a bit short.

Problem

When marking pages as deprecated, there is no indication that it is actually deprecated.

Expected

There is some sort of indication that a page is deprecated, like the orange bubble shown on the home page, and potentially a banner on the top of the article.

I think it would be better to have an archived tag for the dungeons category instead of using the deprecated one, it would make more sense (as the deprecation is for something that's old & maybe inaccurate while archived means it won't move anymore)

Useless to keep them as we are going to implement slash commands

I literally had no idea the navigation bar even existed until a few weeks ago, so it would be nice to make it a bit more user-friendly and visible.

• When opened, let it stay open and you can keep using the docs site like normal. If it would just slide the text over to the right a bit instead of covering everything, it would be a lot more convenient to use and could even be opened by default when looking at a doc.

• Have the categories open by default. Right now, to navigate to a specific page you have to click the specific category before doing so, it would be much more convenient to make it collapsable but open by default, similar to how Discord handles channel categories.

• Make the theme settings consistent with either the main site or make the main site consistent with this — currently the main site has the theme settings in the footer but here and in the webapp it's on the sidebar, either way is fine just make it consistent.

They would follow the same organisation as others repositories (bots, main website...)

For some reason the only place the background is used on the docs site currently is in the navigation bar under the logo, and the rest uses a plain background.

It might also hinder visibility a bit, which is why I'm not entirely sure whether this should be implemented, but I figured I should bring it up anyways.

The current docs site is starting to break down — it's using a version of SvelteKit last updated well over a year ago, the image preprocessor is rapidly approaching an unusable state, and deployment takes ten times what it should.

To combat this, the site is being rewritten using VitePress, a framework actually designed for documentation. It has built in features like dark mode, search, and a dynamic table of contents., which should help make the site easier to maintain in the future and be more lightweight.

Problem

When making changes to the docs site, the time from commit to finishing building takes several minutes. The main site and the webapp take around a minute if not less.

Expected Outcome

The site takes around a minute to build, similar to all the other https://faithfulpack.net based sites.

Notes

Pretty sure Robert said the issue is that the docs site compile all the images again on every commit unnecessarily, increasing build times.

Also not really a high priority change, just a nice quality of life addition that would make changes a lot easier to push.

Describe the feature you'd like

Currently, the table of contents is on the right side of the screen and cannot be hidden. I don't know of like any site which uses the right side for a table of contents, either it's on the left like wikipedia or integrated into the sidebar.

I would like to suggest that we move the table of contents inside the navbar under a dropdown menu in the articles. When opening an article, it would automatically open and be visible, but you could collapse it at any time using an arrow button (similar to Discord categories) or even just hide the navigation menu.

Not only will this bring some valuable screen space back, but it's consistent with most other documentation sites (see the Discord.py documentation example attached below).

Screenshot(s)

Notes

Also would be nice to try and fix issue #13 in the process.
EDIT: This has been implemented.

What happened?

Pretty much exactly what the title says — by opening and collapsing the navigation menu in specific orders you can cause pages to not center properly.

To reproduce

1. Go to https://docs.faithfulpack.net/.
2. Open the navigation sidebar.
3. Navigate to any article that does not contain a table of contents.
4. Collapse the navigation sidebar.
5. Notice how the whole page is off centered to the left.

This persists even after clicking through any number of articles and even on the home page, until you refresh the site.

Screenshot(s)

with the bug:

how it's supposed to look:

Browser name and version

Brave Version 1.49.128
Chromium: 111.0.5563.110

Notes

May be related to the table of contents since it seems to be offset by the right amount to make the table of contents fit if there was one.

Ideally implement #20 if this is part of the issue.