Aholo Examples
Developmentaholo-examplesAholo Examples is an Agent Skill for development published in the manycoretech/aholo-viewer repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
Work on Aholo Viewer example content pairs under website/src/content/examples. Use for creating, modifying, reviewing, or validating example *.json metadata and *.ts runners, Playground presets derived from examples, home-only example runners, config panels, async loading/caching, cleanup, and source shown in Playground.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/manycoretech/aholo-viewer/blob/HEAD/.codex/skills/aholo-examples/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/aholo-examples, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
Aholo Examples
Own example content.
Owns
website/src/content/examples/<slug>.jsonwebsite/src/content/examples/<slug>.ts- Content metadata,
RenderRuntimerunner lifecycle, async loading, IndexedDB caching, config panels, and cleanup. - Source code that appears as a Playground preset.
References
- Use
splatting-basic,splatting-lod-stream,3d-buffer-geometry,3d-point-light, andhome-interactionas normal references. - Read
website/src/content.config.tsfor examples metadata schema. - Read
website/src/client/render-runtime.d.tsfor runner runtime. - Read
website/src/utils/examples.tswhen changing surfaces, ordering, presets, or default examples.
Contracts
- Keep JSON and TS files paired by the same slug.
- Use
surfacesonly when deviating from the default["examples", "playground"]; use["home"]for home-only runners. Do not repeat surface names. - Keep
ordernonnegative and integral,tagsnonempty, andaccentas a six-digit hex color. - Keep Chinese titles technical and concise; keep English titles in SDK documentation style.
- Import renderer APIs from
@manycore/aholo-viewerand use actual public exports. - Export an async default runner that accepts
RenderRuntime. - Check
signal.abortedafter async work and throwAbortErrorwith a specific message. - Use
loading.show()before async fetch/decode andloading.hide()only after the scene is ready. - Return a cleanup function that removes scene objects and destroys created GPU resources.
Boundaries
- Do not change renderer public exports. Surface the need instead.
- Do not edit
packages/renderer/dist/orwebsite/.generated/api/. - Use
aholo-sitefor examples page chrome, Playground shell, client render runtime, or style work.
Validate
- Metadata-only:
pnpm.cmd check:content. - Runner or website integration:
pnpm.cmd check:website. - Renderer API/package interaction:
pnpm.cmd check.