Skip to content

docs: follow-up audit — version staleness, missing menu callbacks, broken links #36

Description

@simons-plugins

After landing #32#35 (commit 4b7a5b6) we did a wider audit of the docs for similar issues. Seven concrete findings, all verified against the files:

Version staleness (4 spots)

  • snippets/plugin-base-template.py:13 — docstring says Indigo 2023.2+ (Python 3.10+). Update to Indigo 2023.2+ (Python 3.10–3.13; 2025.2 recommended).
  • docs/plugin-dev/concepts/scripting-shell.md lines 31, 37, 45 — three CLI command examples all hardcode Indigo 2023.2/IndigoPluginHost.app. Switch the primary examples to Indigo 2025.2 with a one-line note that any 2023.2+ install works (substitute the version in the path).
  • skills/dev/SKILL.md:74Python 3.10+ (Indigo 2023+). Update to reference the version table in quick-start.md (Python 3.10–3.13; see quick-start version table).
  • skills/dev/SKILL.md:75Bundle dependencies in Contents/Packages/ (not system pip) contradicts the now-canonical guidance. Replace with Use requirements.txt — Indigo auto-installs into Contents/Packages/.

Missing ConfigUI callbacks (1 spot — needs verification)

  • docs/plugin-dev/concepts/configui.md lines 333–340 (Validation Callbacks table) and 366–373 (Dialog Close Callbacks table) — both cover Plugin / Device / Action / Event / Device factory but omit Menu item rows. We just documented getMenuActionConfigUiValues(self, menu_id) in docs: add getMenuActionConfigUiValues and getActionConfigUiValues — missing from all docs #35; the validate/closed siblings should have matching entries. Action: please confirm the exact names + signatures in plugin_base.py (likely validateMenuActionConfigUi and closedMenuActionConfigUi, mirroring the camelCase external alias used by getMenuActionConfigUiValues). If they exist, add to both tables.

Broken internal links (2 spots)

  • docs/api/README.md:92 — links to ../indigo-object-model.md; actual file is at ../plugin-dev/api/indigo-object-model.md. Update path.
  • docs/api/overview.md:192 — same broken link as above. Update path.
  • docs/plugin-dev/concepts/README.md:73 — links to ../../CONTRIBUTING.md which does not exist in the repo. Either create a minimal CONTRIBUTING.md or remove the line.

Categories with no findings


Plan: fix the six verifiable items in one follow-up commit on the same branch. Defer the menu validation/closed callbacks (the one needing plugin_base.py verification) until confirmed.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions