SKILL - ISET/isetcam GitHub Wiki
name: github-wiki description: Create, reorganize, audit, or update ISETCam GitHub Wiki pages, including Home and sidebar navigation, internal links, source-code references, images, and archival redirects. Do not use for MATLAB source changes or general docs/ work.
Maintain the user-facing ISETCam GitHub Wiki. Favor accurate, concise, task-oriented guidance over comprehensive restatements of source-code detail.
Read .github/copilot-instructions.md before editing the wiki. For claims
about current APIs, tutorials, examples, data loading, or tests, consult the
sibling ../isetcam checkout when it is available:
-
../isetcam/.github/copilot-instructions.mdfor repository-wide code rules - the matching
../isetcam/.github/skills/<topic>/SKILL.mdfor code workflows -
../isetcam/tutorials/,../isetcam/examples/, and../isetcam/validate/for current runnable names and entry points
Do not duplicate MATLAB runtime, testing, or implementation instructions in
the wiki. If the code repository is unavailable, do not infer current behavior:
identify the claim as needing verification or use an authoritative ISETCam
source on the default branch. Confirm the branch instead of assuming it;
ISET/isetcam uses main as of this writing.
- Identify the requested pages and audience.
- Read the affected page,
Home.md,_Sidebar.md, and directly linked pages before proposing a reorganization. - Treat unlinked pages and overlapping material as review candidates. They may be deliberate historical material; do not add navigation, merge, rename, or delete pages without an explicit decision.
- Make the smallest coherent update that resolves the requested documentation problem. Update Home or sidebar navigation only when the page's role in the learning path changes.
- Use clear, scientifically precise, concise prose. Explain assumptions and model limitations when they affect interpretation.
- Keep the principal learning path task-oriented: installation; scenes; optical images; sensors; image processing and displays; tests and developer material.
- Treat ISETCam as the canonical shared foundation for ISETBio and ISET3D. Both require ISETCam on the MATLAB path. Keep generic pipeline guidance here and link outward only for repository-specific biology or 3D rendering.
- Clearly label supported, advanced or experimental, and historical or retired workflows. Keep retired material out of the normal learning path.
- Preserve useful scientific history through a clearly marked archival or redirect page rather than silently removing it.
- GitHub Wiki pages are a flat collection by default. Do not impose a generic directory taxonomy or YAML frontmatter unless the repository deliberately adopts one.
- Verify cited tutorial, example, public-function, and test-runner names in the current source tree.
- Link a source file with
blob/<default-branch>and a source directory withtree/<default-branch>, after confirming the source repository's default branch. A wrong branch name is a broken link even when the path is correct. - Make published tutorial HTML generated by
iePublishthe primary link for a recommended tutorial, with the.msource link alongside it. GitHub's blob view displays HTML source instead of rendering it, so use the repository's established served URL orhttps://htmlpreview.github.io/?<blob-url-to-the-html-file>. Verify that the.htmlfile is committed, current with respect to the.msource, and visually inspected; never infer its existence from the source filename. Follow the sibling source repository'spublishing-tutorials-examplesskill when regenerating it. - Verify relative wiki links and image paths against files in this repository.
- Use fenced
matlabblocks for MATLAB examples when the language is known; do not guess a language merely to label a code block.
ISETBio and ISET3D depend on ISETCam at runtime and should link here for shared
scene, optical-image, sensor, image-processing, display, color, and metric
concepts. If an update renames or materially changes a stable shared page or
published tutorial, audit ../isetbio.wiki and ../iset3d.wiki for inbound
links. Preserve an old page name with a moved-page stub when external links are
likely.
For a substantive change, check the affected internal links, GitHub source
links, image paths, and cited tutorial, example, and test names. Update related
navigation, published HTML, and screenshots when a page or tutorial is
substantially reorganized. Run the isetcam-wiki-local-preview skill to catch
exact page-name and case mismatches before publishing.
Report which claims were checked against the current ISETCam source and which remain unverified. Do not state that an API, test, tutorial, data collection, or other workflow is supported unless the source confirms it.