Skip to content
FilmOpen.

Contribute documentation

Anyone with a GitHub account can suggest improvements through FilmOpen Issues or Discussions. Reading the documentation does not require signing in.

The website source is private. Maintainers invite trusted documentation and plugin authors to aaronbergen/filmopen.ai; ask in Discussions if you would like to contribute pages. The software and its community live in the public aaronbergen/filmopen repository.

Edit a guide in your browser

Section titled “Edit a guide in your browser”
  1. Accept your repository invitation, then choose Edit page at the bottom of a guide.
  2. Sign in to GitHub and edit the Markdown on a new branch.
  3. Preview the text and describe what changed.
  4. Open a pull request. Maintainers review the change and its website preview before merging.

Use FilmOpen Issues to report a documentation problem without source access. Include the page address and what was confusing or incorrect.

Work locally or with an AI writer

Section titled “Work locally or with an AI writer”

After receiving access, clone the private website repository and use Node.js 24:

Terminal window
npm ci
npm run dev

Edit guides under src/content/docs/docs/. Run the checks before opening a pull request:

Terminal window
npm run verify

An AI writer follows the same process: ordinary Markdown, screenshots committed as assets, and a reviewable pull request. No CMS credentials or database access are required.

Correct a specification

Section titled “Correct a specification”

The two full reference documents are maintained in the application repository. Their Edit page links point there. Propose technical corrections to the original document first.

A website maintainer then refreshes the published snapshots with the import command. Generated reference pages are not edited directly. This keeps the original and its published representation connected.

What a good contribution includes

Section titled “What a good contribution includes”

Explain one task clearly, identify the application or plugin version you checked, and distinguish available features from planned ones. Check links and heading anchors. Add alternative text for images and keep examples small enough to understand.

See the authoring guide for page metadata and formatting.