docs: simplify documentation for 3D printer users by peterus · Pull Request #13 · peterus/LayerNexus

peterus · 2026-03-25T17:30:49Z

Why

The existing docs were too developer-focused. Most LayerNexus users are 3D printer enthusiasts, not developers. The Quick Start assumed cloning from source instead of using the pre-built Docker image.

What Changed

New Structure

Home → Quick Start → Configuration → User Guide → Integrations → Advanced → Development

Key Changes

New Quick Start — Uses ghcr.io/peterus/layernexus:latest, no git clone needed
Configuration — Grouped into Essential vs Optional (not by Django internals)
User Guide — First Steps moved here, simplified permissions table
Advanced — HTTPS, Backup, Docker details separated for power users
Development — New "Building from Source" page, contributing + architecture kept
Language — Warmer, explains Docker/tech concepts, removes jargon
Fix — Added missing ORCASLICER_API_URL to quick-start docker-compose

Removed

getting-started/installation.md (replaced by quick-start.md)
deployment/ directory (split into advanced/ and development/)

Restructure docs with non-technical users in mind: - New Quick Start page using pre-built GHCR image (no cloning/building) - Move building from source to Development section - Simplify Configuration: grouped by Essential vs Optional - Warmer, jargon-free language throughout - Explain Docker concepts for beginners - Simplify permission tables (remove Django internals) - Move Tech Stack to Architecture page - New Advanced section for power-user topics (HTTPS, backup, Docker details) - Fix OrcaSlicer API URL in quick-start docker-compose Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot

Pull request overview

This PR restructures the MkDocs documentation to be more user-focused for 3D printer enthusiasts, replacing developer-centric “Getting Started/Deployment” content with a clearer Quick Start + Configuration + User Guide + Integrations + Advanced + Development flow.

Changes:

Reworked MkDocs navigation and doc IA, adding new Quick Start and reorganizing content into user-centric sections.
Simplified and rewrote key guides (roles/permissions, integrations) with friendlier language and fewer internals.
Split prior deployment docs into new Advanced pages and added a new Development “Building from Source” page.

Reviewed changes

Copilot reviewed 21 out of 22 changed files in this pull request and generated 5 comments.

Show a summary per file

File	Description
mkdocs.yml	Updates nav structure to new doc hierarchy.
docs/index.md	Refreshes homepage copy and links to new entry points.
docs/quick-start.md	Adds new “no git clone” Quick Start using GHCR image.
docs/configuration.md	Adds consolidated configuration reference (essential/optional).
docs/user-guide/first-steps.md	Updates onboarding flow and links to new Quick Start / Advanced pages.
docs/user-guide/projects.md	Small wording/link adjustment to integrations.
docs/user-guide/printing.md	Minor list formatting/link adjustment.
docs/user-guide/roles.md	Simplifies roles/permissions explanation and matrix.
docs/integrations/orcaslicer.md	Simplifies OrcaSlicer integration explanation + troubleshooting.
docs/integrations/moonraker.md	Simplifies printer setup and workflow guidance.
docs/integrations/spoolman.md	Simplifies Spoolman setup guidance and points to Advanced Docker page.
docs/advanced/reverse-proxy.md	Reframes reverse proxy/HTTPS guidance for end users and updates examples.
docs/advanced/docker.md	Adds “Docker Details” (tags, healthcheck, full stack example, etc.).
docs/advanced/backup.md	Adds new backup/restore guide under Advanced.
docs/development/building.md	Adds new “Building from Source” guide for contributors.
docs/development/architecture.md	Adds “Tech Stack” section and updates next steps.
docs/development/contributing.md	Adjusts “Next Steps” links.
docs/getting-started/installation.md	Removes superseded installation guide.
docs/getting-started/configuration.md	Removes superseded configuration guide.
docs/deployment/docker.md	Removes old deployment page (content moved to Advanced).
docs/deployment/docker-compose.md	Removes old docker-compose examples page (content moved to Advanced).
docs/deployment/backup.md	Removes old backup page (content moved to Advanced).

Copilot · 2026-03-25T17:34:39Z

+| Create/edit/delete projects & parts | ✅ | | ✅ |
+| Manage project documents & hardware | ✅ | | ✅ |
+| Add/remove printers | ✅ | ✅ | |
+| Upload G-code & start/cancel prints | ✅ | ✅ | |
+| Import OrcaSlicer profiles | ✅ | ✅ | |
+| Manage filament mappings | ✅ | ✅ | |
+| Add/remove jobs from the print queue | ✅ | ✅ | ✅ |
+| Manage other users | ✅ | | |


In this permission matrix the "not allowed" cells are left blank, which makes the table ambiguous (empty can be read as missing data rather than "no"). Use a consistent explicit marker (e.g., ❌ or —) for disallowed actions so the matrix is unambiguous.

Suggested change

| Create/edit/delete projects & parts | ✅ | | ✅ |

| Manage project documents & hardware | ✅ | | ✅ |

| Add/remove printers | ✅ | ✅ | |

| Upload G-code & start/cancel prints | ✅ | ✅ | |

| Import OrcaSlicer profiles | ✅ | ✅ | |

| Manage filament mappings | ✅ | ✅ | |

| Add/remove jobs from the print queue | ✅ | ✅ | ✅ |

| Manage other users | ✅ | | |

| Create/edit/delete projects & parts | ✅ | ❌ | ✅ |

| Manage project documents & hardware | ✅ | ❌ | ✅ |

| Add/remove printers | ✅ | ✅ | ❌ |

| Upload G-code & start/cancel prints | ✅ | ✅ | ❌ |

| Import OrcaSlicer profiles | ✅ | ✅ | ❌ |

| Manage filament mappings | ✅ | ✅ | ❌ |

| Add/remove jobs from the print queue | ✅ | ✅ | ✅ |

| Manage other users | ✅ | ❌ | ❌ |

Copilot · 2026-03-25T17:34:39Z

+- [Contributing guide](contributing.md)
+- [Architecture overview](architecture.md)


The "Next Steps" section links to contributing.md, which is the current page, so it doesn't help readers navigate. Replace this with links to the next most relevant pages (e.g., Building from Source, Architecture overview, or other developer docs) and avoid self-referential navigation.

Suggested change

- [Contributing guide](contributing.md)

- [Architecture overview](architecture.md)

- Read the [Architecture overview](architecture.md) to understand the system design.

Copilot · 2026-03-25T17:34:39Z

+
+| Variable | What It Does | Default |
+|---|---|---|
+| `ORCASLICER_API_URL` | Where to find the OrcaSlicer API for slicing. If you use the docker-compose from the [Quick Start](quick-start.md), this is set automatically. | `http://localhost:3000` |


This says ORCASLICER_API_URL is "set automatically" when using the Quick Start compose, but the Quick Start guide currently has users set it explicitly in the environment: section. Consider rephrasing to "already included in the Quick Start docker-compose" (or similar) to avoid confusion about where it comes from.

Suggested change

| `ORCASLICER_API_URL` | Where to find the OrcaSlicer API for slicing. If you use the docker-compose from the [Quick Start](quick-start.md), this is set automatically. | `http://localhost:3000` |

| `ORCASLICER_API_URL` | Where to find the OrcaSlicer API for slicing. If you use the docker-compose from the [Quick Start](quick-start.md), this is already included in the configuration. | `http://localhost:3000` |

Copilot · 2026-03-25T17:34:40Z

+docker run --rm \
+  -v layernexus_layernexus_media:/data:ro \
+  -v "$(pwd)/$BACKUP_DIR":/backup \
+  alpine cp -r /data/ /backup/media/


The "Backup from Named Volumes" command for uploaded files copies the /data directory itself into /backup/media/, which typically results in a nested media/data/... folder rather than a media/<files> layout. Adjust the copy to copy the contents of /data into /backup/media so the backup structure matches the original media directory.

Suggested change

alpine cp -r /data/ /backup/media/

alpine cp -r /data/. /backup/media/

Copilot · 2026-03-25T17:34:40Z

+
+```bash
+docker compose stop web
+docker cp ./backup-media/ $(docker compose ps -q web):/app/media/


The restore command for uploaded files (docker cp ./backup-media/ ...:/app/media/) will usually copy the backup-media directory into /app/media/ (creating /app/media/backup-media/...) instead of restoring the contents back into /app/media/. Use a copy pattern that copies the contents of the backup directory into /app/media/.

Suggested change

docker cp ./backup-media/ $(docker compose ps -q web):/app/media/

docker cp ./backup-media/. $(docker compose ps -q web):/app/media/

Copilot AI review requested due to automatic review settings March 25, 2026 17:30

Copilot started reviewing on behalf of peterus March 25, 2026 17:31 View session

Copilot AI reviewed Mar 25, 2026

View reviewed changes

peterus merged commit e53d647 into main Mar 25, 2026
8 checks passed

peterus deleted the docs/simplify-for-users branch March 25, 2026 17:35

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: simplify documentation for 3D printer users#13

docs: simplify documentation for 3D printer users#13
peterus merged 1 commit intomainfrom
docs/simplify-for-users

peterus commented Mar 25, 2026

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Copilot AI Mar 25, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

		- [Contributing guide](contributing.md)
		- [Architecture overview](architecture.md)

	- [Contributing guide](contributing.md)
	- [Architecture overview](architecture.md)
	- Read the [Architecture overview](architecture.md) to understand the system design.

	\| `ORCASLICER_API_URL` \| Where to find the OrcaSlicer API for slicing. If you use the docker-compose from the [Quick Start](quick-start.md), this is set automatically. \| `http://localhost:3000` \|
	\| `ORCASLICER_API_URL` \| Where to find the OrcaSlicer API for slicing. If you use the docker-compose from the [Quick Start](quick-start.md), this is already included in the configuration. \| `http://localhost:3000` \|

	alpine cp -r /data/ /backup/media/
	alpine cp -r /data/. /backup/media/

	docker cp ./backup-media/ $(docker compose ps -q web):/app/media/
	docker cp ./backup-media/. $(docker compose ps -q web):/app/media/

Conversation

peterus commented Mar 25, 2026

Why

What Changed

New Structure

Key Changes

Removed

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Mar 25, 2026

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants