Required Pages Sync

Last modified: 2/24/2026

Required Pages Sync

The Required Pages Sync page (/admin/required-pages) compares the built-in required-pages/ source files shipped with ngdpbase against the live pages and allows administrators to synchronize them.

Overview

Required pages are pages that ngdpbase ships with — documentation pages, plugin reference pages, and system pages. They are stored in the required-pages/ directory in the application source and are the authoritative source for those pages. The sync tool detects when live content has diverged from the source and provides tools to bring them back in line.

Status Values

Each required page is shown with one of four statuses:

StatusColorMeaning
**Current**GreenThe live page is byte-for-byte identical to the source. No action needed.
**Modified**YellowThe source file has changed since the live page was last synced. The live page is out of date.
**New**BlueThe source page does not yet exist in the live pages. It has never been synced.
**UUID Mismatch**RedA page with the same title or slug already exists in the live pages but under a different UUID than the source expects. Reconciliation is required before syncing.

Actions

Sync

Copies the source file from required-pages/ into the live pages directory (data/pages/). Applies to pages with status New or Modified.

Diff

Available for Modified and UUID Mismatch pages. Opens a side-by-side or unified diff view comparing the source file content against the live page content. A full-page diff view is also available.

UUID Mismatch Reconciliation

When a live page exists at the same title or slug as a required page but with a different UUID, two reconciliation options are available:

Both options resolve the UUID mismatch so the page can be managed normally going forward.

Summary Badges

The top of the page shows badge counts for each status:

Source Location

Required page source files live in the required-pages/ directory of the ngdpbase application. Each file is named {uuid}.md where the UUID is the canonical identifier for that page. These files are checked into the application repository and updated with each release.