diff --git a/.vitepress/theme/style.css b/.vitepress/theme/style.css index bfec87201..49f8e8c4c 100644 --- a/.vitepress/theme/style.css +++ b/.vitepress/theme/style.css @@ -97,8 +97,8 @@ } /* Keybinding CSS ( tags) */ -kbd { - background-color: #eee; +kbd:not(.DocSearch-Button-Key) { + background-color: #eee !important; border-radius: 3px; border: 1px solid #b4b4b4; box-shadow: 0 1px 1px rgba(0, 0, 0, 0.2), diff --git a/contributing.md b/contributing.md index 072cb3d07..329e97c20 100644 --- a/contributing.md +++ b/contributing.md @@ -19,15 +19,18 @@ All contributions must follow our [style guidelines](#style-guidelines). If you want to translate the documentation into your language, you can do this on the [Fabric Crowdin page](https://crowdin.com/project/fabricmc). -## Contributing Content {#contributing-content} + +## new-content Contributing Content {#contributing-content} Content contributions are the main way to contribute to the Fabric Documentation. -All content contributions go through three stages: +All content contributions go through the following stages, each of which is associated with a label: -1. Guidance for Expansion (if needed) -2. Content Verification -3. Cleanup (Grammar etc.) +1. locally Prepare your changes and push a PR +2. stage:expansion: Guidance for Expansion if needed +3. stage:verification: Content verification +4. stage:cleanup: Grammar, Linting... +5. stage:ready: Ready to be merged! All content must follow our [style guidelines](#style-guidelines). @@ -44,7 +47,7 @@ You can read more about the GitHub flow [here](https://docs.github.com/en/get-st You can either make changes from the web interface on GitHub, or you can develop and preview the website locally. -#### locally Cloning Your Fork {#clone-your-fork} +#### Cloning Your Fork {#clone-your-fork} If you want to develop locally, you will need to install [Git](https://git-scm.com/). @@ -55,7 +58,7 @@ After that, clone your fork of the repository with: git clone https://github.com/your-username/fabric-docs.git ``` -#### locally Installing Dependencies {#install-dependencies} +#### Installing Dependencies {#install-dependencies} If you want to preview your changes locally, you will need to install [Node.js 18+](https://nodejs.org/en/). @@ -65,7 +68,7 @@ After that, make sure to install all dependencies with: npm install ``` -#### locally Running the Development Server {#run-the-development-server} +#### Running the Development Server {#run-the-development-server} This will allow you to preview your changes locally at `localhost:5173` and will automatically reload the page when you make changes. @@ -75,7 +78,7 @@ npm run dev Now you can open and browse the website from the browser by visiting `http://localhost:5173`. -#### locally Building the Website {#building-the-website} +#### Building the Website {#building-the-website} This will compile all Markdown files into static HTML files and place them in `.vitepress/dist`: @@ -83,7 +86,7 @@ This will compile all Markdown files into static HTML files and place them in `. npm run build ``` -#### locally Previewing the Built Website {#previewing-the-built-website} +#### Previewing the Built Website {#previewing-the-built-website} This will start a local server on port `4173` serving the content found in `.vitepress/dist`: @@ -91,7 +94,7 @@ This will start a local server on port `4173` serving the content found in `.vit npm run preview ``` -#### locally Opening a Pull Request {#opening-a-pull-request} +#### Opening a Pull Request {#opening-a-pull-request} Once you're happy with your changes, you may `push` your changes: @@ -103,25 +106,34 @@ git push Then, follow the link in the output of `git push` to open a PR. -### 2. Guidance for Expansion if Needed {#2-guidance-for-expansion-if-needed} +### 2. stage:expansion Guidance for Expansion if Needed {#2-guidance-for-expansion-if-needed} -If the documentation team thinks that you could expand upon your pull request, a member of the team will add the `can-expand` label to your pull request alongside a comment explaining what they think you could expand upon. If you agree with the suggestion, you can expand upon your pull request. +If the documentation team thinks that you could expand upon your pull request, a member of the team will add the stage:expansion label to your pull request alongside a comment explaining what they think you could expand upon. If you agree with the suggestion, you can expand upon your pull request. -Don't feel pressured to expand upon your pull request. If you don't want to expand upon your pull request, you can simply ask for the `can-expand` label to be removed. +If you do not want to expand upon your pull request, but you are happy for someone else to expand upon it at a later date, you should create an issue on the [Issues page](https://github.com/FabricMC/fabric-docs/issues) and explain what you think could be expanded upon. The documentation team will then add the help-wanted label to your PR. -If you do not want to expand upon your pull request, but you are happy for someone else to expand upon it at a later date, it's best to create an issue on the [Issues page](https://github.com/FabricMC/fabric-docs/issues) and explain what you think could be expanded upon. +### 3. stage:verification Content Verification {#3-content-verification} -### 3. Content Verification {#3-content-verification} +This is the most important stage as it ensures that the content is accurate and follows the Fabric Documentation style guide. -All pull requests adding content undergo content verification, this is the most important stage as it ensures that the content is accurate and follows the Fabric Documentation style guide. +In this stage, the following questions should be answered: -### 4. Cleanup {#4-cleanup} +- Is all of the content correct? +- Is all of the content up-to-date? +- Does the content cover all cases, such as different operating systems? -This stage is where the documentation team will fix any grammar issues and make any other changes they deem necessary before merging the pull request! +### 4. stage:cleanup Cleanup {#4-cleanup} -## Contributing Framework {#contributing-framework} +In this stage, the following happens: -Framework refers to the internal structure of the website, any pull requests that modify the framework of the website will be labeled with the `framework` label. +- Fixing of any grammar issues using [LanguageTool](https://languagetool.org/) +- Linting of all Markdown files using [`markdownlint`](https://github.com/DavidAnson/markdownlint) +- Formatting of all Java code using [Checkstyle](https://checkstyle.sourceforge.io/) +- Other miscellaneous fixes or improvements + +## framework Contributing Framework {#contributing-framework} + +Framework refers to the internal structure of the website, any pull requests that modify the framework of the website will be labeled with the framework label. You should really only make framework pull requests after consulting with the documentation team on the [Fabric Discord](https://discord.gg/v6v4pMv) or via an issue. @@ -137,8 +149,6 @@ If you are unsure about anything, you can ask in the [Fabric Discord](https://di All original documentation is written in English, following the American rules of grammar. -While you may use [LanguageTool](https://languagetool.org/) to check your grammar as you type, don't stress too much about it. Our documentation team will review and correct grammar during the cleanup stage. However, making an effort to get it right initially can save us time. - ### Add Data to the Frontmatter {#add-data-to-the-frontmatter} Each page must have a `title` and a `description` in the frontmatter. diff --git a/develop/items/food.md b/develop/items/food.md index 6af950d50..c0c3150c9 100644 --- a/develop/items/food.md +++ b/develop/items/food.md @@ -31,7 +31,6 @@ The `FoodComponent.Builder` class has many methods that allow you to modify what | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `nutrition` | Sets the amount of hunger points your item will replenish. | | `saturationModifier` | Sets the amount of saturation points your item will add. | -| `meat` | Declares your item as meat. Carnivorous entities, such as wolves, will be able to eat it. | | `alwaysEdible` | Allows your item to be eaten regardless of hunger level. | | `snack` | Declares your item as a snack. | | `statusEffect` | Adds a status effect when you eat your item. Usually a status effect instance and chance is passed to this method, where chance is a decimal percentage (`1f = 100%`) | diff --git a/players/troubleshooting/crash-reports.md b/players/troubleshooting/crash-reports.md index c5c4a7986..955a4661a 100644 --- a/players/troubleshooting/crash-reports.md +++ b/players/troubleshooting/crash-reports.md @@ -41,7 +41,7 @@ Crash reports can be found in the following locations: Crash reports are very long, and can be very confusing to read. However, they contain a lot of information about the crash, and can help you find the cause of the crash. -For this guide, we will be using [this crash report](/public/assets/players/crash-report-example.txt). +For this guide, we will be using [this crash report](/assets/players/crash-report-example.txt). ::: details Show Crash Report