diff --git a/Home.md b/Home.md index 29ac465..168d3a3 100644 --- a/Home.md +++ b/Home.md @@ -16,10 +16,6 @@ OrcaSlicer is a powerful open source slicer for FFF (FDM) 3D Printers. This wiki - [General Settings](#general-settings) - [Developer Section](#developer-section) -> [!WARNING] -> This wiki is community-maintained. -> Some pages may be **outdated** while others may be **newer** and present only in [nightly build](https://github.com/OrcaSlicer/OrcaSlicer/releases/tag/nightly-builds) or [latest release](https://github.com/OrcaSlicer/OrcaSlicer/releases). - > [!NOTE] > Please consider contributing to the wiki following the [How to contribute to the wiki](How-to-wiki) guide. diff --git a/developer-reference/How-to-wiki.md b/developer-reference/How-to-wiki.md index c414f54..43a6f77 100644 --- a/developer-reference/How-to-wiki.md +++ b/developer-reference/How-to-wiki.md @@ -17,6 +17,7 @@ When adding new features, consider updating the wiki so users can access the lat - [Formatting and Style](#formatting-and-style) - [Markdown Formatting](#markdown-formatting) - [Alerts and Callouts](#alerts-and-callouts) + - [New Content](#new-content) - [Images](#images) - [Image Sources](#image-sources) - [OrcaSlicer Resources](#orcaslicer-resources) @@ -191,6 +192,28 @@ Use GitHub's alert syntax to add inline notes and warnings: > [!NOTE] > Refer to the [GitHub Alerts documentation](https://docs.github.com/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts) for more details. +#### New Content + +The Wiki should be updated to reflect the latest stable release with the addition of new features present in current nightly builds. + +When new features or upgrades are merged into the main branch, please add a note using the following format: + +```markdown +> [!IMPORTANT] +> NEW FEATURE: **Feature short description** +> Available in: +> [Nightly builds](https://github.com/OrcaSlicer/OrcaSlicer/releases/tag/nightly-builds) or releases grater than **stable version number at merge time**. +``` + +Example: + +> [!IMPORTANT] +> NEW FEATURE: **Input Shaping Calibration Types** +> Available in: +> [Nightly builds](https://github.com/OrcaSlicer/OrcaSlicer/releases/tag/nightly-builds) or releases grater than **2.3.1**. + +This notes should be removed after a new stable release is made that includes the new feature. + ## Images Images are encouraged to enhance the clarity and quality of the wiki content. They help illustrate concepts, provide examples, and improve readability.