Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Move older shader versions to new .md #37

Closed
atashi764 opened this issue Jul 4, 2024 · 3 comments
Closed

Move older shader versions to new .md #37

atashi764 opened this issue Jul 4, 2024 · 3 comments
Labels
suggestion Improvements or additions to list

Comments

@atashi764
Copy link
Contributor

Most people will download only the latest version and not care about older versions.

You may want to move all the older version links to another .md

and also leave a link to the same #title of the new.md

by doing this, the readme.md will become easier to read and write. currently, it's easy to get lost in dozens of older links.

@DominoKorean
Copy link
Owner

It doesn't seem necessary to separate the documentation for the old and new versions of the shaders. (From a management perspective, separating the documents would make it harder to manage.)
Instead, I will consider moving the shaders that support the current changed materials to the top and organizing the previous versions using the <details> tag to allow for collapsible sections.

@atashi764
Copy link
Contributor Author

makes sense. i went through the readme today and i felt that links to older version makes the md look messy.

i mean lets assume a shader has 100 older versions, then you will have to add 100 extra lines in the same md.

instead what i wanted is something like this

README.md
oldversions.md

in README it would look like this:

Newb X Legacy

(shields.io badges>)
v15.49 (beta)
Android
iOS
Windows

Links to older and beta versions: https://github.com/DominoKorean/Render-dragon-shader-list/blob/main/oldversions.md#newb-x-legacy

and in oldversions.md

Newb X Legacy

(shields.io badges)
v15.49 (beta)
Android
iOS
Windows

v15.48 (beta)
Android
iOS
Windows
100 other versions

i suggested this because:

  1. most people will not download older version anyways
  2. having more links in one file will degrade page loading performance over time
  3. from user perspective the page wouldn't look that bad. but from editor perspective it just lowers clear visibility of everything

@DominoKorean
Copy link
Owner

Although I am in a fast internet environment with 5G, I am not sure if having many links or lines significantly slows down the loading speed of the document. If this truly causes a noticeable lag, it is certainly worth considering.
However, sometimes the shader updates to a new version and stops working, which means I occasionally need to refer to older versions. It is very inconvenient to have to search for these materials each time.
Given that the RenderDragon shader list currently experiences an average of 40,000 daily traffic, it is important to consider the various situations of different users.

From a management perspective, although these aspects can make pull requests challenging, this is not a concern for the majority of users.

As long as the document loading speed is not slowed down, I do not currently plan to change this aspect.

@DominoKorean DominoKorean added the suggestion Improvements or additions to list label Jul 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
suggestion Improvements or additions to list
Projects
None yet
Development

No branches or pull requests

2 participants