docs

SkillDocs & knowledge

Building and editing JustRelax.jl documentation (Documenter + DocumenterVitepress). Use when changing docs, docstrings, or the docs build.

Available today. Use it from your connected AI after setup.

No other account needed.

Connect ahel once, and every AI you use reads what you have installed.

Then ask your AI: use the docs skill

What this skill tells your AI

The instructions your AI receives, as published by ptsolvers/justrelax.jl in .claude/skills/docs/SKILL.md and read by ahel’s review.

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/.

Source pages: 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.
New pages must be added to the pages list in docs/make.jl to appear in navigation.
The docs env loads 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.
PR doc previews are cleaned up by 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.

Advanced