Enhances both build.ps1 and build.sh to copy the contents of the web_extras directory into the wiki output folder, ensuring extra assets are available in the generated site. Adds warnings if the web_extras directory or specific files are missing.
Co-authored-by: yw4z <yw4z@outlook.com>
* Normalize path separators in navigation links
Replaces backslashes with forward slashes in relative paths when generating navigation items to ensure consistency across different operating systems.
* Fix URL encoding and path normalization in build script
Normalizes path separators to forward slashes for URLs and updates URL encoding to only encode spaces, preserving forward slashes. This improves the correctness of generated redirect URLs in the build process.
Updated the GitHub Actions deploy-wiki workflow to install the mkdocs-gh-admonitions-plugin package. This enables support for admonitions in the wiki documentation build process.
Reworded the explanation for 'Full fan speed at layer' to improve clarity on how fan speed increases and when the ramping is ignored based on layer settings.
Improved explanations for part-cooling fan settings, including clearer descriptions of initial layer cooling, fan speed ramping, and auxiliary fan behavior. Added cross-references between material cooling and printer accessory documentation for better usability.
Added a warning note indicating that the adaptive volumetric speed feature is experimental, incomplete, and imported from BBS. Clarifies that it is only functional for some profiles with the variable already saved.
* Optimize images
* Fix image link + add Multiline data
* Document multiline infill support in pattern reference
Updated the infill documentation to reference a new 'Multiline' column in the Patterns Quick Reference table, replacing the previous static list of supported patterns. The patterns table now includes a 'Multiline' column for each pattern, indicating its compatibility and linking to the relevant infill strategy. Pattern descriptions were also updated to include a 'Multiline' field for clarity.
* Revise arc fitting documentation for clarity and detail
Expanded and reorganized the arc fitting section to clarify its purpose, advantages, disadvantages, and compatibility considerations. Added explicit lists for pros and cons, improved warnings and tips, and updated explanations to help users better understand when and why to use arc fitting.
* Update quality_settings_precision.md
* Expand power loss recovery documentation
Added details about how power loss recovery works, potential issues with frequent memory writes, and recommendations for enabling arc fitting to reduce G-code commands.
* Update printer_basic_information_advanced.md
* Add documentation for 'Brim use EFC outline' option
Documents the new 'Brim use EFC outline' setting, explaining its purpose and usage in relation to Elephant Foot Compensation. This helps users understand when to enable the option and its potential effects on brim adhesion and removal.
* Update
* Update others_settings_brim.md
* Update arc fitting feature description and notes
Clarified the arc fitting feature's impact on print quality and G-code size. Added notes on CPU usage and recommendations for Klipper machines.
The idea is to stop with the myth that arcs print better than segments, since usually it's not the case
* Clarify arc fitting feature description
formatting
* Update quality_settings_precision.md for clarity
Clarify the impact of arc fitting on print quality and CPU usage.
* Correct segment length from 0.6 mm to 0.4 mm
Updated the segment length comparison in quality settings documentation.
* Refine segment length details in quality settings
Updated the segment length range for OnShape's default preset 'Fine' in the quality settings documentation.
* Refine arc fitting feature explanation in documentation
Shortened
* Update quality_settings_precision.md
* Improve clarity on arc fitting and its effects
Clarified the explanation of arc fitting and its implications for print quality, especially for low-quality STLs and older printers. Added notes on CPU usage and provided a link for Klipper printer configuration.
* Refine documentation on arc fitting feature
Clarified the purpose and implications of arc fitting in G-Code generation. Improved readability and precision of the documentation regarding print quality and printer performance.
* Clarify usage of arc resolution settings in documentation
Added a note about the use of arc resolution settings.
* Update print_settings/quality/quality_settings_precision.md
Co-authored-by: Ian Bassi <ian.bassi@outlook.com>
* Revise arc fitting section for clarity and accuracy
Clarified the purpose and implications of arc fitting in G-Code generation, emphasizing the need for printer compatibility and potential quality impacts.
---------
Co-authored-by: Ian Bassi <ian.bassi@outlook.com>
Changed code block language from 'gcode' to 'c++' for syntax highlighting and improved formatting in G-code examples. Also refined example conditions and descriptions for clarity.
* Add troubleshooting tip for missing 'Fix model' option in VS build
Added a new tip to the Windows Visual Studio build instructions to help users resolve the issue where the 'Fix model' context menu option is missing. The tip explains how to ensure the Windows SDK is properly included and provides step-by-step guidance for updating project properties in Visual Studio.
Co-Authored-By: BMacours <74008704+bmacours@users.noreply.github.com>
* Update How-to-build.md
* Improve formatting
---------
Co-authored-by: BMacours <74008704+bmacours@users.noreply.github.com>
Updated acceleration values in the calibration table for clarity and consistency. Added explicit example data sets and improved formatting in both the calibration and material flow ratio documentation to better illustrate how to enter adaptive pressure advance measurements.
* Add Power Loss Recovery documentation
Added a new section describing the Power Loss Recovery feature for Bambu Lab and Marlin 2 firmware printers. Includes usage notes, recommendations, and cautions regarding memory wear and model warping.
* Update printer_basic_information_advanced.md
* Slimed and just enable (for now i hope)
Updated the regex in validate_tab_links.yml to match any valid identifier before '.label_path', not just 'line'. This allows the workflow to detect label_path assignments for more objects.
* Add example for custom start G-code sequence
Included a detailed example demonstrating custom notifications with M300 and a purge sequence in the start G-code section.
* Add important note on safe use of machine G-code
Added a warning highlighting the power and risks of custom machine G-code scripts. The note advises users to use known G-code bases for their firmware and to thoroughly test scripts before production use.
* Add firmware G-code documentation links
Added helpful links to Marlin, RepRap, and Klipper G-code documentation to guide users in referencing supported commands for their printer firmware.
* Update code block language to gcode in docs
Changed code block language from 'c++' to 'gcode' in printer_machine_gcode.md for better syntax highlighting and clarity in G-code examples.
* Update printer_basic_information_accessory.md
* Update printer_basic_information_adaptive_bed_mesh.md
* Update bed type documentation and images
Replaced outdated bed type GIF with two new PNG images illustrating bed type selection and material temperature settings. Updated documentation to reflect new bed types, improved instructions, and added references to the new images.
Created keyboard_shortcuts.md to document all available keyboard shortcuts in the application, organized by context (Global, Prepare, Toolbar, Objects list, Preview) for improved user workflow and reference.
Based in KBShortcutsDialog.cpp
Deleted the unused 14+15R.png image and removed extra blank lines from the infill rotation template metalanguage documentation for improved readability.
Introduces two GitHub Actions workflows: one to find orphaned markdown files and another to detect unreferenced images in the repository. These checks run on pull requests affecting markdown files and help maintain documentation and asset hygiene by surfacing unused files.
The Built-in placeholders variables documentation was rewritten and expanded with detailed tables, context explanations, and usage conventions for OrcaSlicer G-code scripting. New sections cover filename templates, custom G-code contexts, and environment variables. A reference image was added to illustrate variable key discovery. Related links in G-code output settings were updated to point to the new filename template section.
Definitions that were in calibrations were moved to their correct location.
Calibrations were linked to their articles and vice versa.
MD structures were improved.
Minor changes.
Update image and internal link validation workflows to scan all Markdown files in the repository instead of only those changed in a pull request. This improves coverage and reliability by ensuring all relevant files are validated regardless of PR diff context.
Refactored link reference collection to handle append_option_line calls more robustly and improved argument parsing. Enhanced line number calculation for error messages and updated failure formatting to include GitHub links. Failures are now sorted by line and only messages are exported.
Enhanced the GitHub workflow to detect Tab link references from label_path and append_option_line in addition to append_single_option_line. Updated the developer wiki to document all three supported methods for linking options to wiki pages, including examples and link format details.
Enhanced the material settings section by adding missing icons to the Setting Overrides and Multimaterial links, and improved the Material temperatures link formatting for better visual consistency.
Replaces standalone image and link markdown with combined image-link markdown for better readability and consistency throughout the settings documentation. No content changes, only formatting improvements.
Provides sample Marlin G-code snippets demonstrating how to set fan speed and pressure advance based on extrusion roles. This helps users customize machine behavior for specific print scenarios.
Co-authored-by: Rodrigo Faselli <162915171+rf47@users.noreply.github.com>
Merged 'Material Fan' and 'Cooling for Specific Layer' docs into a unified 'Material Cooling' page, updating navigation in Home.md accordingly. Removed the obsolete 'material_cooling_for_specific_layer.md' file and expanded the cooling documentation for clarity and completeness.
* Printer home base
* Create printer_basic_information_printable_space.md
* Document multi bed type support in printable space
Moved and expanded documentation for multi bed type support from bed-types.md to printer_basic_information_printable_space.md. The new section explains enabling multi bed types, selecting bed types, setting temperatures, and using the curr_bed_type variable in custom G-code. Removed redundant bed-types.md file.
* advance
* Create printer_basic_information_cooling_fan.md
* Create printer_basic_information_extruder_clearance.md
* adaptative bed mesh
* Printer accesory
* Update Home.md
* Create printer_machine_gcode.md
* MOVED
* Create printer_multimaterial_wipe_tower.md
* Create printer_multimaterial_setup.md
* Create printer_multimaterial_semm_parameters.md
* Create printer_multimaterial_advanced.md
* Update multimaterial setup links and remove semm.md
* Create printer_extruder_basic_information.md
* Create printer_extruder_layer_height_limits.md
* Refactor extruder docs and add retraction/Z-hop info
Moved layer height limits and extruder position sections into 'printer_extruder_basic_information.md', deleted the separate layer height limits file, and added new documentation for extruder retraction and Z-hop settings. Updated Home.md navigation to reflect these changes and improve clarity for users.
* Add printer motion ability documentation
Introduces a new markdown file detailing motion-related printer settings, including speed, acceleration, jerk limitations, resonance avoidance, and G-code emission options.
* Add icons to printer settings navigation links
Updated the printer settings section in Home.md to include relevant SVG icons for each navigation link, improving visual clarity and user experience. This change affects links under Basic Information, Multimaterial, and Extruder subsections.
* Clarify Auto option in Z-hop type documentation
Updated the description for the 'Auto' Z-hop type to specify that it selects automatically between Spiral based on whether the travel move crosses over overhang areas.
* Update printer-preset.png
