SiteDocs

[nbcommunication]

For a number of years we've used an internal module to produce 'help' content for clients, and I've recently been motivated to improve on this and make something that should be easy enough for AgentTools to generate/update content for. Here it is:

SiteDocs: https://github.com/nbcommunication/SiteDocs

Two modules that work together to give you internal site documentation, right inside the PW admin:

• SiteDocs — the data/logic module. Creates the docs templates, fields, and handles access control and search.
• ProcessSiteDocs — the admin Process module. Renders the docs index, single-page views, a print-friendly manual, and the admin navigation.

The documentation lives as a single nested page tree under a hidden index, so editing just uses the normal PW page edit/add screens — no separate docs-only editor to learn.

Features

• Per-page visibility via a sitedocs_roles field — if a page doesn't set its own roles, it inherits from the nearest ancestor that does (Superusers always have access)
• Docs pages show up in admin live search results under a "Docs" group
• Print-friendly manual view at Admin > Docs > Print manual
• Optional custom CSS/JS files, configurable site name
• If you're running the AgentTools module, there's a "Notes for Agent Tools" config field for AI agent context

Requirements

• ProcessWire 3.0.240+
• AdminThemeUikit (either default or original)
• body and images fields (created automatically if missing)
• InputfieldTinyMCE recommended for the body field (falls back to CKEditor, then plain textarea)
• the dom PHP extension, for heading rewrite and on-page anchor links

Here's a few screenshots (caveats: from an install with default UIkit theme customised, and Claude generated docs for testing)

 

Cheers,

Chris, NB

[maximus]

Great Job for use AgentTools implementation.