Skip to content

copilot instructions

Brian Wandell edited this page Aug 20, 2026 · 1 revision

ISET3D Wiki Instructions

This repository contains the user-facing ISET3D wiki. It does not contain the MATLAB source code.

Source of truth for code facts

When documenting current APIs, tutorials, examples, rendering, data loading, or tests, consult the sibling ISET3D repository when it is available:

  • ../ISET3d/.github/copilot-instructions.md — repository-wide code guidance
  • ../ISET3d/.github/skills/<topic>/SKILL.md — task-specific code workflows
  • ../ISET3d/tutorials/, ../ISET3d/examples/, and ../ISET3d/validate/ — runnable names and current entry points

Do not duplicate MATLAB, Docker, rendering, or implementation procedures here. If the sibling repository is unavailable, do not infer current API behavior; flag the fact for verification or use an authoritative source on ISET3D's main branch.

Editorial scope

  • Keep the Home page and sidebar task-oriented, concise, and current.
  • Use the current ISET3D source tree as the authority for supported public workflows. Link source files to the main branch, never retired paths.
  • Clearly distinguish supported local workflows from advanced remote, cloud, or experimental workflows and historical or retired material.
  • Keep durable user guidance in this wiki. Put developer implementation detail in ISET3D's docs/ directory or in its task-specific skills.
  • Preserve useful scientific history through a clearly marked archival or redirect page rather than silently removing context.

Consistency checks

Before publishing a substantive update, check the affected internal links, GitHub source links, image paths, and names of cited tutorials, examples, and test runners. Update related navigation and screenshots when a page is substantially reorganized.

Do not claim that an API, rendering mode, test, tutorial, data collection, or other workflow is supported unless the current ISET3D source confirms it.

Clone this wiki locally