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

Minestom Wiki Rework #29

Open
wants to merge 9 commits into
base: master
Choose a base branch
from
Open

Conversation

DersWasTaken
Copy link
Contributor

The goal of this PR is to slowly introduce changes to the minestom wiki to make it more approachable for newer users and already experienced developers.

The goals I currently have are:

  • Introduce a new style and color palette to the wiki that is more approachable and helps users get a better understanding of what is going on.
  • Introduce both basic and advanced usage sections of the wiki for players who are just starting out and those who want to do higher level things. Currently the distinction is very unclear, and certain aspects such as Thread Architecture are explained to users at the beginning, when they should be more oriented towards advanced programmers.
  • Make the basic section of the wiki formatted as more of a guide than documentation, walking the user through in an interactive way as they get used to minestom.
  • Introduce a CONTRIBUTION guide for others who may wish to contribute to the wiki.

The first PR here introduces some basic changes to alerts, adding a custom :::alert (type) markdown syntax that currently supports the following types:

  • Important
  • Info
  • Note
  • Danger
  • Warning
  • Success

These aim to introduce further tools for a website maintainer to use when writing sections of the wiki. The style is not final and may be changed later on.

@DersWasTaken
Copy link
Contributor Author

Please don't close the PR if changes are merged as I wish to continue to put changes to the wiki that are apart of this general PR here.

@DersWasTaken
Copy link
Contributor Author

Additionally the new documents in FAQ are very much work in progress, and are not ready to be hosted on the website, but I feel keeping them inside the PR is good incase anyone would like to suggest edits to them.

@DersWasTaken
Copy link
Contributor Author

DersWasTaken commented Mar 5, 2025

Possibly will need to revert commit for font changes, however Legend is (to me) an acceptable compromise between simplicity and allowing for better accessibility for people with Dyslexia. Another alternative to consider would possibly be having a setting that changes the website into an 'accessibility' mode.

I am open to other font suggestions.

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.

2 participants