Developer docs/Get started

PeltyCMS developer docs

These pages are generated by make docs (the pelty-docs crate) from the code itself: the router, the OpenAPI schema, the event registry, the WASM runtime types, the WIT world, the UI schema, the config loader, the migrations directory and the example addon in extensions/examples/addon-guide. If a page and the code disagree, the generator is wrong. Please report it as a bug.

#Start here

• Getting started: run PeltyCMS locally and build the docs.
• Write a plugin in Rust: a complete addon, feature by feature, using code that CI compiles and tests.
• Events and hooks: listen to events, cancel or modify them, and emit your own.
• Addon UI: native pages, iframe pages and slots.

#Reference

• HTTP API: every registered route (api.json is the OpenAPI 3 document).
• Event registry, hooks and mixins, capabilities, addon.json manifest, WIT / ABI, UI schema.
• Configuration, CLI, database migrations.

#Machine-readable files

• api.json: OpenAPI 3 document, every registered route
• routes.json: route inventory (path, method, handler, source)
• events.json: event registry
• emit-sites.json: where each event is emitted (file:line)
• slots.json: UI injection points per page
• plugin-api.json: capabilities, hooks, mixins, manifest fields, UI schema
• env.json: environment variables
• migrations.json: database migrations