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

[Major Rework] Lofty Pillars #231

Merged

Conversation

alexytomi
Copy link
Contributor

@alexytomi alexytomi commented Dec 31, 2024

What is this PR for?

From the void of the nonexistent 'Towers' Rework, 'Pillars' is here to replace it! It has been called 'Lofty' because I am of the opinion that this will significantly turn the wiki into a better state in all the ways (except information, that comes after the merge with the way too many changes)


What does this PR change?

The sidebar configuration and in-addition, utilizing the previously unused navbar

  • The navigation bar is a feature that has been completely ignored and glossed over, leading to over-dependence on the sidebar. This is NOT what Vuepress was designed for.
    • Using the official documentation for Vuepress as reference, I remade the wiki to utilize both features. This was originally made as a demonstration for the effectiveness of the new config system but it seems to be a good addition overall. hence it's inclusion.
  • The sidebar is now path dependent to be compatible with the PR changes.

The entire folder structure

  • I've organized the various pages into folders for much easier access. The new 'root' directory for markdown is now markdown.
    • Further nesting of Wiki pages is encouraged with the new vuepress config setup.

Addition of primitive documentation for contributors

  • This should help any future stewards of the wiki to get familiarized with it.
    • It is not documented within the wiki itself to prevent confusion as the search bar plugin searches for all pages created, which are all markdown files within the markdown folder, even if inaccessible from the side and nav bars.

What does this all do for the project?

The changes are a move towards a more modern JavaScript ecosystem as well as a simple yet extensible configuration system. I've utilized newer syntax wherever possible and allowed by the old Vuepress v1 system as well as lowered the boilerplate and confusion created by the immense bracket nesting. This should all simplify the edits most often required to be done, apart from editing markdown files themselves.

@alexytomi
Copy link
Contributor Author

Also fixes #229

@alexytomi alexytomi marked this pull request as ready for review January 2, 2025 07:02
@alexytomi alexytomi force-pushed the Project/Lofty_Pillars branch 2 times, most recently from 635d480 to 4fe32d3 Compare January 5, 2025 04:18
@RealEthanPlayzDev RealEthanPlayzDev self-assigned this Jan 5, 2025
sa1672ndo and others added 20 commits January 5, 2025 14:09
cleaned up some stuff and added couple of mods

Signed-off-by: sa1672ndo <[email protected]>
iOS 18 is horrible

Signed-off-by: ItAnthon <[email protected]>
Signed-off-by: Dev1ss0 <[email protected]>
Signed-off-by: Dev1ss0 <[email protected]>
This reworks the folder structure as well as the sidebar to work
alongside the navbar.

This makes mobile navigation easier.

The config file changes should allow everyone the old niceities of not
specifying the path for every bloody file while having an actual folder
structure that makes sense.

This is already a feature in vuepress v2 but oh well, here's my
reimplementation of that at least.

The new thing to edit for contributors will be arrays.js.
Edits variable names, fixes a 404 link, and reorders arrays.js to have
Android and iOS as their own objects rather than existing within FAQ in
a gigantic object property.
…utter comments

Incomplete because I'd be documenting stale things, which is pretty
stupid
This file is supposed to be a config for an editor, hence it overrides
the configs of everyone else.

In theory this is good, in practice no one cares. This also looks
horribly ugly since it uses tabs rather than spaces. Removing it seems
sane.
… added some jsdoc comments

Created a new function that handles non-grouped sidebar configuration in
arrays.js rather than crudely hardcode the variable names within the
sidebar definition + some indentation fixes + jsdoc syntax for comments
in js
@alexytomi alexytomi force-pushed the Project/Lofty_Pillars branch from 4fe32d3 to db0a034 Compare January 5, 2025 06:10
@RealEthanPlayzDev RealEthanPlayzDev merged commit 5667bcb into PojavLauncherTeam:main Jan 5, 2025
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Outdated link that breaks the 'Help us improve this page!' link in the wiki
5 participants