The Developer Guide is for people writing themes and plugins. This track is for people running a Scriptor site: installing it once, keeping its content up to date, configuring it for the audience, and operating it over time.
Thirteen topics across four areas. Each topic is one page. Read in order if you are new; jump to the area you need if you are not.
How each topic is laid out
Every topic follows the same shape:
- What this covers. One paragraph on the task and when you do it. If it does not match what you came here for, scan the sidebar.
- Walkthrough. Step-by-step, with screenshots where the UI is not obvious from the text. Click paths use the same labels the editor renders, so the page works as a checklist.
- What to check after. A short list of things that should look right when the task is done. Useful for handoff or for running through this as a script.
- Troubleshooting. Two or three things that commonly go wrong, with the fix. Skipped when the task is straightforward.
- See also. Related operator topics, the relevant Developer Guide concept for readers who want the why, and the API Reference page if the topic touches a configurable surface.
Snippets are command-line for install and operations; UI labels
for editor topics. No code-archeology: if a setting is named
site.title in the editor and siteTitle in config.php, the
topic uses the editor label and mentions the config key once.
What's covered
Thirteen topics across four areas:
Getting Started (3)
Land a Scriptor instance and log in the first time.
| Topic | What you do |
|---|---|
| Install Scriptor | Docker quickstart, native install, shared-hosting variant |
| First boot and admin login | Reach the editor, log in, change the seed password |
| Editor UI tour | Sidebar, top bar, modal preview, where everything lives |
Editing Content (4)
The work most editors spend most of their time on.
| Topic | What you do |
|---|---|
| Create and edit pages | Title, slug, parent, status, body content |
| Files and images | Upload via FilePond, alt text, captions, image titles |
| Drafts and preview | Save without publishing, preview in modal, publish when ready |
| Reorder, move, and delete pages | Drag-drop in the page tree, parent change, delete with cleanup |
Site Configuration (3)
The settings that shape what the site looks like and who can edit it.
| Topic | What you do |
|---|---|
| Site settings and theme switch | Title, language, timezone, swap themes |
| Users and access | Add a user, change a password, role basics |
| Installed plugins | What the Plugins module shows, how to read versions, enable/disable |
Operations (3)
Keep the site healthy over time.
| Topic | What you do |
|---|---|
| Backup and restore | Where the DB and files live, what to copy, how to restore |
| Updating Scriptor | composer update path, migration step, post-update checks |
| Logs and troubleshooting | Where logs live, common errors, what to look at first |
Ordering and PR batching
Topics land in five PRs after the plan PR, grouped by area so each PR reviews as a coherent unit:
| # | PR | Topics |
|---|---|---|
| 1 | Getting Started | Install, first boot, editor tour |
| 2 | Editing Content A | Pages, files & images |
| 3 | Editing Content B | Drafts & preview, reorder/move/delete |
| 4 | Site Configuration | Site settings, users, installed plugins |
| 5 | Operations | Backup/restore, updating, logs |
Getting Started ships first because the rest of the track assumes you have a working install and a logged-in editor; the other PRs can land in any order after that.
What's not in the user guide
Three categories are deliberately out of scope:
- Theme and plugin authoring. That is the Developer Guide: concepts, two tutorials, API reference, cookbook. The user guide treats themes and plugins as installable units, not as code.
- System administration deeper than "where logs live". Tuning PHP-FPM, reverse-proxy headers, or systemd unit files is a web hosting topic, not a Scriptor one. The user guide mentions when a setting interacts with the hosting layer and links out.
- Migration from Scriptor 1.x or other CMSes. Scriptor 2.0 is a ground-up rewrite; there is no upgrade path from 1.x. If that changes, a separate migration guide will live next to this track, not inside it.
If a topic you wanted is missing, the API Reference covers the configurable surface and the Developer Guide concepts cover the mechanics. Open a discussion if it should be a canonical operator topic; this track grows by addition.
Where to go next
If you are setting up a new instance, start at Install Scriptor and work down.
If your site is already running and you are taking it over from someone else, Editor UI tour is the fastest orientation; then jump to whichever Site Configuration topic the handoff did not cover.
If you are an editor who has been handed a working site, the Editing Content row is everything you need for day-to-day work.
This track lands one PR at a time, in the order in the table above. The first chapter PR (Getting Started) opens immediately after this plan PR merges.
