Document a plugin

Invited plugin authors can contribute documentation through the same GitHub workflow as the core guides. The website source is private; see contribution access before opening its template or editing a page. Keep each plugin’s pages in its own folder so its maintainers can review them together.

Specification and implementation

The format describes plugin contracts, hooks, and extension behavior. The milestone 3 application reads plugin definitions in its shared library; it does not provide a complete general plugin-execution workflow. State what your extension actually supports and where it runs.

Start with the template

Copy templates/plugin.md into a new folder under src/content/docs/docs/plugins/. Set a unique slug such as docs/plugins/your-plugin. Plugin pages appear automatically in the navigation tree.

Include:

• The plugin’s purpose, maintainer, source repository, and licence.
• Supported FilmOpen format and application versions.
• Installation and execution instructions for the environment that actually runs it.
• Inputs, outputs, configuration, and a minimal working example.
• File changes, network access, and required credentials, if applicable.
• Limitations, troubleshooting, and a support link.

Keep the documentation reviewable

Commit screenshots and examples with the page. Use real output from the plugin and remove private paths, credentials, and personal information before publishing a screenshot.

Submit a pull request. Maintainers may add trusted plugin authors as reviewers for their documentation folders. GitHub review ownership does not provide a security boundary around a folder; publication remains a maintainer decision.

Read the authoring guide and the format’s extension contracts before submitting.