Skip to content

docs: print file routing - #326

Open
raykholo wants to merge 8 commits into
fdm-monster:mainfrom
raykholo:docs/print-file-routing
Open

docs: print file routing#326
raykholo wants to merge 8 commits into
fdm-monster:mainfrom
raykholo:docs/print-file-routing

Conversation

@raykholo

@raykholo raykholo commented May 20, 2026

Copy link
Copy Markdown

Part of fdm-monster/fdm-monster#5290.

New Software usage → Print File Routing page: how routing works, the watched folder (by-printer//by-tag/, consume vs library, polling), the fdmm_target slicer tokens, what happens when a file matches more than one printer, and a deployment-examples section (incl. a Samba-share docker-compose for slicing from a separate PC).

Also adds the WATCHED_FOLDER_* variables to the Environment Variables reference, plus a sidebar entry.

Documentation: Print File Routing Guide

Added a new user-facing guide explaining how FDM Monster automatically routes sliced files to the correct printer or printer group. Highlights:

  • New "Print File Routing" page describing watched-folder routing and slicer-embedded routing tokens (fdmm_target, plus fdmm_target_printer / fdmm_target_tag).
  • Clear behavior for conflicts and multi-printer/tag cases (files that resolve to more than one printer are imported and await manual assignment).
  • New environment variables documented for watched folders: WATCHED_FOLDER_PATH, WATCHED_FOLDER_MODE (consume vs library), and WATCHED_FOLDER_POLLING — with polling guidance scoped to Docker Desktop and network shares.
  • Practical deployment example: Docker + Samba compose snippet for sharing a watched folder from another PC.
  • Sidebar updated to include the new page.

This should make it easier for users to set up distributed or multi‑printer workflows and networked slicing.

Review Change Stack

@coderabbitai

coderabbitai Bot commented May 20, 2026

Copy link
Copy Markdown

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 11499040-9846-446f-83f4-86356b1dd7d7

📥 Commits

Reviewing files that changed from the base of the PR and between 9cb2830 and be5bd42.

📒 Files selected for processing (1)
  • docs/configuration/environment_variables.mdx
✅ Files skipped from review due to trivial changes (1)
  • docs/configuration/environment_variables.mdx

📝 Walkthrough

Walkthrough

This PR adds documentation for FDM Monster’s print file routing: a new guide describing watched-folder and slicer-comment routing, environment variables to configure watched folders, a Docker+Samba example, and a sidebar entry to surface the page.

Changes

Print File Routing Documentation

Layer / File(s) Summary
Print File Routing Guide
docs/software_usage/print_file_routing.mdx
Introduces watched-folder routing with folder structure (by-printer/, by-tag/), file consumption vs library behavior, polling vs notifications across local/Docker/network filesystems, handling of ambiguous/multiple printer matches, slicer-based routing via fdmm_target comments, and a Docker + Samba example.
Environment Variables Reference
docs/configuration/environment_variables.mdx
Documents WATCHED_FOLDER_PATH, WATCHED_FOLDER_MODE, and WATCHED_FOLDER_POLLING with defaults and notes on enabling/disabling and polling considerations.
Documentation Site Navigation
sidebars.ts
Adds software_usage/print_file_routing to the Software usage section of the Docusaurus sidebar.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~5 minutes

Possibly related issues

Poem

🐰 I hop through folders, bright and spry,
Placing prints where they belong, not awry,
By tag or name, or gcode's small mark,
Through Docker paths or networks dark,
The guide hums a trail — follow my hop!

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title 'docs: print file routing' directly and concisely describes the main change—adding documentation for the print file routing feature. It accurately reflects the primary objective of this PR.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint skipped: no ESLint configuration detected in root package.json. To enable, add eslint to devDependencies.


Comment @coderabbitai help to get the list of available commands and usage tips.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/configuration/environment_variables.mdx`:
- Line 72: The description for WATCHED_FOLDER_POLLING is too broad; update the
table text for the `WATCHED_FOLDER_POLLING` variable to scope polling as
required only for Docker Desktop bind mounts and network shares (or adjust to
mirror the routing guide's exact matrix), and clarify that local Linux Docker
setups and local disks may support native events and can set polling to `false`;
modify the single-line table entry accordingly to avoid stating "required for
Docker bind mounts" generically.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 0c39b3de-e1e5-4f43-bae1-3c2e9a1cbfe2

📥 Commits

Reviewing files that changed from the base of the PR and between 41c9ed4 and 9cb2830.

📒 Files selected for processing (3)
  • docs/configuration/environment_variables.mdx
  • docs/software_usage/print_file_routing.mdx
  • sidebars.ts

Comment thread docs/configuration/environment_variables.mdx Outdated
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.

1 participant