Skip to content

wagtail-unveil Documentation

Discover and test every URL in your Wagtail site — frontend and admin.

This is the canonical documentation hub for wagtail-unveil.

Use wagtail-unveil

  • Getting Started — Canonical starting point for installation, quick start, and first-time setup.
  • Features — Canonical user-facing guide to reports, the settings page, and the dashboard panel.
  • Configuration — Canonical reference for package settings, API key configuration, and platform dependency manifest configuration.
  • API Reference — Canonical reference for versioned JSON API endpoints, including URL discovery and platform runtime metadata.
  • Recipes — Task-focused guides for extending wagtail-unveil in your own project.

Contribute / maintain

  • Contributing — Canonical contributor routing page for development, architecture, assets, API lifecycle, and release workflow.
  • Development Guide — Contributor workflow entry point for local setup, validation, and day-to-day commands.
  • Discovery Architecture — Canonical deep reference for discovery and resolution behavior.
  • Releasing — Canonical maintainer runbook for package releases.

Reference Map

  • README.md is a thin package overview and quick-start entry point for repository visitors.
  • docs/index.md is the canonical navigation hub for all documentation.
  • Section index pages under docs/ route readers to the right reference area without duplicating deep content.
  • Contributor docs distinguish canonical references from companion material:
  • development.md is the workflow entry point
  • discovery-architecture.md is authoritative for discovery rules
  • discovery-workflows.md is a visual companion to that architecture guide