Deutsche Version

Back to overview

Wiki.js Plugin: Workflows

This documentation always describes the latest published version.

Updating an existing page safely

wikijs_update_page replaces the entire content. Proceed like this:

1. Load the page with wikijs_get_page (give path and locale, the default is en).
2. Change the complete text locally.
3. Send the whole new text with wikijs_update_page, plus isPublished: true.
4. For an intentional large reduction, also set confirmContentShrink: true.
5. Read the page again and check the result.

wikijs_get_page returns pages with more than 100,000 characters truncated. An update would write the truncated text, including the notice, back. Do not edit such pages through this tool.

Creating new docs with docs-wiki

graph TD
    A["Start docs-wiki"] --> B["Clarify project type and project"]
    B --> C["Inventory from the code"]
    C --> D["Generate hub and sub-pages, DE and EN"]
    D --> E["source-check"]
    E --> F["translation-check"]
    F --> G["Publish: sub-pages, then hub"]
    G --> H["Read updatedAt and wikijs_mark_verified"]

1. Invoke /wikijs-plugin:docs-wiki and give project type, project and mode.
2. The skill builds an inventory from the code and plans the hub and sub-pages.
3. Source check and translation check run over the whole page set. On FAIL it is corrected, on WARN you decide.
4. The DE sub-pages are created first, then the DE hub, then EN, and the category card last.
5. Every page is written with isPublished: true and the Git state of the project (sourceRepo, sourceRef, summary).
6. After publishing, updatedAt is read per page and language and the checked ref is marked.

Checking existing docs (baseline)

/wikijs-plugin:source-check baseline

The run changes no page. It marks passed pages and reports findings. Corrections then go through the normal docs-wiki update flow.

Updates from the code diff

If a page has a valid verified ref (wikijs_get_verified_refs, page_updated_at matches the live updatedAt), source-check reads only the files changed since then and the changed text sections. Without a valid ref the whole page is checked, and that run becomes the new baseline.

Rebuilding a single page into hub and sub-pages

1. Load DE and EN and inventory the sections.
2. Assign each section exactly one target page, no section may be dropped.
3. Run source check and translation check over the finished page set.
4. Create the sub-pages, then reduce the hub to the short version with wikijs_update_page (confirmContentShrink: true).
5. Repair incoming links and switch the category card to the sub-pages.

Reading history and verified markers

Searching and moving pages

1. Find the affected pages with wikijs_search_pages.
2. Call wikijs_move_page with destinationPath for each page.
3. Update references in other pages and in category pages. History and verified markers stay with the old path.

Background on database and server is on the Technical page.