Skip to content

docs: new-example-prompt requires a render that the pathology convention forbids #146

Description

@TMHSDigital

Conflict

docs/new-example-prompt.md requires every new example to produce a gallery render ("produce a deliberate, well-framed render rather than a mockup").

CLAUDE.md (pathology / sidecar convention) says those examples get no still, no gallery entry, and no preview image. AGENTS.md / CONTRIBUTING.md smoke coverage is a catalog.json row; gallery is only for still-bearing examples.

The two docs disagree. The next author will hit the same fork.

Which document wins today

CLAUDE.md / the pathology convention. Do not add a still just to satisfy the prompt.

Used in:

Examples the exception covers

Shipped pathology / sidecar examples with no gallery still:

  • examples/exit-pre-sidecar/
  • examples/ngon-triangulate/
  • examples/unapplied-scale-gltf/
  • examples/coincident-vert-weld/
  • examples/gn-bundle-roundtrip/
  • examples/vse-linear-modifiers/
  • examples/eval-mesh-datablock-name/
  • examples/mesh-automasking-settings/

Resolution used (do not bake this into a mixed examples PR)

Follow CLAUDE.md: catalog row + README + falsifier + exit table; omit gallery.json, hero webp, preview webp, and gallery_framing.py.

Reconciling the two authoring docs is its own change. This issue tracks that; do not fix it as a drive-by on an example PR.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

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