Menu
Building and editing JustRelax.jl documentation (Documenter + DocumenterVitepress). Use when changing docs, docstrings, or the docs build.
Install with Codex or Claude Copy this prompt, paste it into Codex, Claude, or another assistant, and let it review the skill page and install it for you.
How JustRelax.jl handles CPU/CUDA/AMDGPU backends — module structure, package extensions, ParallelStencil initialization rules. Use when adding/modifying kernels or anything device-related.
ParallelStencil kernel idioms and GPU-compatibility rules for JustRelax.jl, plus the Runic formatting requirement. Use when writing or editing compute kernels or any Julia source.
How to run JustRelax.jl tests — single files, the full ParallelTestRunner suite, backend selection, and MPI tests. Use whenever running or debugging tests.
How to run JustRelax.jl miniapps (benchmarks, convection, subduction) to validate solver/physics changes end-to-end. Use when verifying a physics change beyond unit tests.
Releasing a new JustRelax.jl version — version bumps, compat bumps, JuliaRegistrator, TagBot. Use when preparing or asked about a release.
Based on SOC occupation classification
| name | docs |
| description | Building and editing JustRelax.jl documentation (Documenter + DocumenterVitepress). Use when changing docs, docstrings, or the docs build. |
Docs use Documenter.jl + DocumenterVitepress (Vitepress theme, deployed by .github/workflows/Documenter.yml).
julia --project=docs -e 'using Pkg; Pkg.develop(path="."); Pkg.instantiate()'
julia --project=docs docs/make.jl
The Vitepress build requires Node; DocumenterVitepress handles it via NodeJS_jll. Built site lands in docs/build/.
docs/src/ (index.md, man/ for manual pages, assets/).docs/make.jl auto-generates docs/src/man/license.md, security.md, and authors.md from the repo-root LICENSE.md, SECURITY.md, AUTHORS.md — never edit those generated files; edit the root files instead.pages list in docs/make.jl to appear in navigation.GeoParams and JustPIC too, so doctests/examples can use them.docs/paper/ is the JOSS paper — separate from the user docs, don't mix content.DocPreviewCleanup.yml; nothing to do manually.When changing exported API, update the relevant page in docs/src/man/ and the docstring in the same PR.