docs: plugin dev/test process guide (#21)

[FullGas1]

Summary

• docs/plugin-dev-guide.md + .fr.md: full plugin lifecycle guide (creation, Busted tests, DCS visual testing loop, CI)
• Covers the dev/test iteration pattern established by metal-farp: inject_scene -> observe -> cleanup -> fix -> repeat
• Documents the neighbour-repo convention (../CTLD/) once, centrally
• mkdocs.yml: guide added under "For authors" nav section
• plugins/_template/tests/template_spec.lua: pointer to the guide for new plugin authors

Closes #21

Test plan

• CI passes (validate-docs, build)
• Guide renders correctly on versioned docs site (both EN and FR)
• "Plugin dev guide" appears in the "For authors" nav section

Generated with Claude Code

Summary by Sourcery

Add a comprehensive plugin development and testing guide to the documentation and surface it in navigation and template tests.

Enhancements:

• Reference the central plugin dev guide from the plugin template test to guide new plugin authors.

Build:

• Register the plugin development guide in mkdocs navigation under the "For authors" section.

Documentation:

• Add English and French plugin development and test guides covering plugin lifecycle, unit testing, DCS visual testing, and CI expectations.

[sourcery-ai]

Reviewer's Guide

Adds a new bilingual plugin development and testing guide to the docs, wires it into site navigation and the plugin template tests, and documents the standard dev/test loop and repo layout for CTLD plugins.

Sequence diagram for the CTLD plugin dev/test loop

sequenceDiagram
  actor Developer
  participant CTLD_repo as CTLD_repo
  participant CTLD_plugins_repo as CTLD_plugins_repo
  participant dcs_bridge as dcs_bridge
  participant DCS as DCS

  Developer->>DCS: Load mission Test_CTLD-plugins.miz
  Developer->>DCS: Take pilot slot uh1-1

  Developer->>dcs_bridge: Inject CTLD.lua from CTLD_repo
  dcs_bridge->>DCS: Execute CTLD.lua

  Developer->>dcs_bridge: Inject CTLD_{name}.lua from CTLD_plugins_repo
  dcs_bridge->>DCS: Execute CTLD_{name}.lua

  loop Play scene (repeatable)
    Developer->>dcs_bridge: Inject inject_scene.lua
    dcs_bridge->>DCS: playSceneAtPos via inject_scene.lua
    DCS-->>Developer: Visual observation of scene
  end

  alt Problem detected
    Developer->>dcs_bridge: Inject cleanup.lua
    dcs_bridge->>DCS: Execute cleanup.lua (destroy all but uh1)
    Developer->>CTLD_plugins_repo: Fix plugin Lua scene
    Developer->>dcs_bridge: Re-inject CTLD_{name}.lua
  end

Loading

File-Level Changes

Change	Details	Files
Introduce a detailed English and French plugin development and test guide describing the full CTLD plugin lifecycle, dev/test loop, neighbour-repo layout, and CI gates.	Create English guide covering plugin creation from template, README front-matter, Lua scene rules, Busted unit testing expectations, DCS visual test workflow, and CI checks. Create French translation of the same guide with equivalent structure and content. Document the neighbour-repo convention (CTLD and CTLD_plugins side-by-side) and the inject_scene/cleanup dev loop established by metal-farp.	docs/plugin-dev-guide.md docs/plugin-dev-guide.fr.md
Expose the new plugin dev guide in the MkDocs navigation under the "For authors" section.	Add a "Plugin dev guide" entry pointing to plugin-dev-guide.md under the existing "For authors" nav group. Preserve existing navigation items for plugins and template docs.	mkdocs.yml
Update the plugin template test file to point new authors to the central plugin dev/test guide.	Extend the header comment in the template_spec Lua test to reference docs/plugin-dev-guide.md as the canonical dev/test guide. Include the rendered docs site URL so authors can access the guide from the published documentation.	plugins/_template/tests/template_spec.lua

Assessment against linked issues

Issue	Objective	Addressed	Explanation
#21	Create docs/plugin-dev-guide.md (and associated docs) that cover the full CTLD plugin lifecycle: creating a plugin, writing unit tests, DCS visual testing including the inject -> observe -> cleanup -> fix dev/test loop, and CI; define the neighbour-repo convention once centrally and have RECIPE.md files reference this loop rather than duplicate it.	✅
#21	Add the plugin development guide to MkDocs navigation so it appears on the versioned docs site.	✅
#21	Add a pointer to the plugin development guide in plugins/_template/ so new plugin authors discover it immediately (e.g., in README or template_spec.lua).	✅

Possibly linked issues

• docs: plugin dev/test process guide #21: PR adds plugin-dev-guide docs, MkDocs nav, and template pointer exactly matching the requested lifecycle guide in the issue.

---

Tips and commands

Interacting with Sourcery

• Trigger a new review: Comment @sourcery-ai review on the pull request.
• Continue discussions: Reply directly to Sourcery's review comments.
• Generate a GitHub issue from a review comment: Ask Sourcery to create an
  issue from a review comment by replying to it. You can also reply to a
  review comment with @sourcery-ai issue to create an issue from it.
• Generate a pull request title: Write @sourcery-ai anywhere in the pull
  request title to generate a title at any time. You can also comment
  @sourcery-ai title on the pull request to (re-)generate the title at any time.
• Generate a pull request summary: Write @sourcery-ai summary anywhere in
  the pull request body to generate a PR summary at any time exactly where you
  want it. You can also comment @sourcery-ai summary on the pull request to
  (re-)generate the summary at any time.
• Generate reviewer's guide: Comment @sourcery-ai guide on the pull
  request to (re-)generate the reviewer's guide at any time.
• Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
  pull request to resolve all Sourcery comments. Useful if you've already
  addressed all the comments and don't want to see them anymore.
• Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
  request to dismiss all existing Sourcery reviews. Especially useful if you
  want to start fresh with a new review - don't forget to comment
  @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

• Enable or disable review features such as the Sourcery-generated pull request
  summary, the reviewer's guide, and others.
• Change the review language.
• Add, remove or edit custom review instructions.
• Adjust other review settings.

Getting Help

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey - I've left some high level feedback:

• In plugins/_template/tests/template_spec.lua, consider pointing directly to the specific rendered guide path (e.g., /plugin-dev-guide/) rather than the docs root URL so new authors land on the exact page intended.
• The English guide says the plugin README is "FR prose + YAML front-matter" while the French version calls it the source of truth for docs; to avoid confusion for authors, align this wording so it clearly reflects the expected language and structure of README files regardless of locale.

Prompt for AI Agents

Please address the comments from this code review:

## Overall Comments
- In `plugins/_template/tests/template_spec.lua`, consider pointing directly to the specific rendered guide path (e.g., `/plugin-dev-guide/`) rather than the docs root URL so new authors land on the exact page intended.
- The English guide says the plugin README is "FR prose + YAML front-matter" while the French version calls it the source of truth for docs; to avoid confusion for authors, align this wording so it clearly reflects the expected language and structure of README files regardless of locale.

---

Sourcery is free for open source - if you like our reviews please consider sharing them ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}