Skip to content

SKILL

Jump to bottom
Brian Wandell edited this page Aug 22, 2026 · 2 revisions

name: github-wiki description: Create, reorganize, audit, or update ISET3D 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.

ISET3D GitHub Wiki

Maintain the user-facing ISET3D GitHub Wiki. Favor accurate, concise, task-oriented guidance over comprehensive restatements of source-code detail.

Start with the authorities

Read .github/copilot-instructions.md before editing the wiki. For claims about current APIs, tutorials, examples, rendering, data loading, or tests, consult the sibling ../ISET3d checkout when it is available:

  • ../ISET3d/.github/copilot-instructions.md for repository-wide code rules
  • the matching ../ISET3d/.github/skills/<topic>/SKILL.md for code workflows
  • ../ISET3d/tutorials/, ../ISET3d/examples/, and ../ISET3d/validate/ for current runnable names and entry points

Do not duplicate MATLAB, Docker, rendering, 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 ISET3D source on the default branch (currently master for ISET/iset3d — check with git remote show origin rather than assuming main, since that default can differ by repository and can change).

Scope the update

  1. Identify the requested pages and audience.
  2. Read the affected page, Home.md, _Sidebar.md, and directly linked pages before proposing a reorganization.
  3. 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.
  4. 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.

Write for current ISET3D users

  • Use clear, scientifically precise, concise prose. Explain assumptions and model limitations when they affect interpretation.
  • Keep the principal learning path task-oriented: installation; local rendering; scenes and assets; recipe and camera setup; human-eye rendering; tests and developer material.
  • Clearly label supported local workflows, advanced remote or cloud workflows, experimental workflows, and historical or retired material. Keep advanced or 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.

Reference source and assets correctly

  • 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 with tree/<default-branch>, where <default-branch> is ISET/iset3d's actual default branch (master as of this writing — confirm with git remote show origin in the ../ISET3d checkout rather than assuming main). A link built against the wrong branch name renders as a GitHub 404, which is easy to miss without clicking through — a wrong branch name has broken links in this wiki before.
  • .m files render fine as plain blob/<default-branch> links — GitHub shows them as syntax-highlighted source. Published tutorial .html files do not: GitHub's blob view shows HTML source as text rather than rendering it. Wrap those in the htmlpreview redirector instead: https://htmlpreview.github.io/?<blob-url-to-the-.html-file>. Only link a published .html file this way if it actually exists in the source tree — see the publishing-tutorials-examples skill in ISET3D for how tutorials get published, and do not assume a .html counterpart exists next to a .m tutorial unless you've verified it.
  • Verify relative wiki links and image paths against files in this repository.
  • Use fenced matlab blocks for MATLAB examples when the language is known; do not guess a language merely to label a code block.

Review before publishing

For a substantive change, check the affected internal links, GitHub source links, image paths, and cited tutorial, example, and test names. Update related navigation and screenshots when a page is substantially reorganized.

Report which claims were checked against the current ISET3D source and which remain unverified. Do not state that an API, rendering mode, test, tutorial, data collection, or other workflow is supported unless the source confirms it.

Clone this wiki locally