guide-convention SKILL.md skillA

guide-convention from heptameta/heptabase-explainer-studio is an agent skill: a SKILL.md folder an AI agent loads when a task calls for it.

Install it, pinned
mdr add heptameta/heptabase-explainer-studio/guide-convention@git:20261014.722ad9d

Pins git:20261014.722ad9d in mdr.lock. Pin the fingerprint instead.

Audit grade
A, 17 of 17 checks passed
Kind
SKILL.md skill
Repository
heptameta/heptabase-explainer-studio
Path
.claude/skills/guide-convention/SKILL.md
Versions recorded
1
Latest version
git:20261014.722ad9d, committed Oct 14, 2026
Size
3,634 bytes
Repository stars
3
License
Apache-2.0

What goes in the guide (explainer_studio/guide/), what the skill in the Heptabase plugin relies on, and how the guide is written: in English, with everything specific to one language kept in references/languages/<language>.md. Use before writing or changing any file under explainer_studio/guide/ or the doctor, setup or guide commands, and when reviewing such a change.

Collected from public GitHub. Every version is saved exactly as it was and never changes. Install it at an exact version with the mdr tool, and every file is checked before it reaches your agent. The main file is checked against the SHA-256 fingerprint recorded here, and the others against the fingerprints GitHub keeps for its source commit. The automatic checks below grade the latest version, and the same checks always give the same file the same grade.

What the file says

# Writing the guide

## The guide and the skill

The command carries the guide. The skill that installs the command is in the Heptabase plugin
(`plugins/heptabase/skills/explainer-studio/` in `heptameta/heptabase-agent-plugins`), whose `AGENTS.md` says what it
holds: only getting the command ready and running `explainer-studio guide`. Every installed plugin keeps its copy until
the plugin is updated, so everything about making videos goes in the guide (`guide.md`, `workflow/`, `references/`):
it is installed with the command, so it always matches the version that runs.

The skill and the command depend on each other across the two repositories:

- the skill runs `doctor`, `setup` and `guide`;
- its install scripts install the latest release tag `v<version>` of this repository, with the Python that
  `PYTHON_VERSION` in `cli/upgrade.py` names;
- the command and the guide send the agent to the skill's `scripts/install.sh` and `scripts/install.ps1` to install uv
  and the latest release: when uv is missing, to upgrade on Windows, and when ManimGL is broken.

Keep these working, or add a new form beside the old one. A change on the skill's side goes to that repository, in a
…

Read the whole file at its exact version.

How to install

The exact contents, by fingerprint
mdr add heptameta/heptabase-explainer-studio/guide-convention@sha256:4eccc7272c1bb197

The line at the top of this page pins the label git:20261014.722ad9d, which is what most people want. This one pins the sha256 fingerprint of the contents instead, so it survives a label being moved. Either way the exact version is written to mdr.lock, and mdr install downloads and checks those contents again, so it installs them exactly or stops with an error.

Badge

mdr badge

[![mdr](https://markdownregistry.com/badge/art_wzmfh2ub6cmsjskb.svg)](https://markdownregistry.com/a/art_wzmfh2ub6cmsjskb)

0 badge image fetches in 30 days. What the badge shows.

Versions

The registry has recorded 1 version of this file, committed on Oct 14, 2026.

versioncommittedcommitsizeaudit
git:20261014.722ad9d latest2026-10-14 722ad9d 3,634 BA view

Audit of the latest version

A  17 of 17 checks passed. Fixed automatic checks with no AI involved, so the same checks give the same answer every run.
  • pass: Frontmatter block present
  • pass: Frontmatter declares a name
  • pass: Frontmatter declares a description
  • pass: Size between 200 bytes and 200 KB (3634 bytes)
  • pass: No zero-width or bidi control characters
  • pass: No instruction hidden inside an HTML comment
  • pass: No link to an exfiltration or paste host
  • pass: No credential-shaped string
  • pass: No instruction to send local credentials anywhere
  • pass: No text hidden with inline styles
  • pass: No prompt-injection phrasing
  • pass: No curl or wget piped into a shell
  • pass: No recursive delete of root, home or parent
  • pass: No instruction to read or print local credentials
  • pass: No base64 blob over 200 characters
  • pass: No link to a raw IP address
  • pass: No script tag

Source

GitHub

heptameta/heptabase-explainer-studio · 3 stars · license Apache-2.0 · pushed 2026-10-22 · branch main

API

GET https://markdownregistry.com/api/v1/artifacts/art_wzmfh2ub6cmsjskb
GET https://markdownregistry.com/api/v1/resolve?ref=heptameta/heptabase-explainer-studio/guide-convention
GET https://markdownregistry.com/api/v1/blob/4eccc7272c1bb197bd3dc2ade2f108598318975f27a7f75f87bfa99eb8aa24c5

Your AI assistant does the legwork. You hear about the deals worth your word. Hand yours the standing instructions at modelranch.com and it joins the network that reads files like this one.

Guides: the SKILL.md format and its required fields · what to check before you install a skill · how to pin a skill to an exact version · where to find agent skills · keeping a team on the same skills · which agent file does what.

More from heptameta/heptabase-explainer-studio

commit-and-pull-request-convention SKILL.md skill
heptameta/heptabase-explainer-studio · .claude/skills/commit-and-pull-request-convention/SKILL.md · How Explainer Studio commits and pull requests are written, covering branches, Conventional Commits subjects…
git:20261020.33db214 · audit A · 3 stars
judging-changes SKILL.md skill
heptameta/heptabase-explainer-studio · .claude/skills/judging-changes/SKILL.md · How to decide whether and where to change Explainer Studio's teaching behaviour, how much evidence a change needs, and…
git:20261014.bb251f8 · audit A · 3 stars
naming-convention SKILL.md skill
heptameta/heptabase-explainer-studio · .claude/skills/naming-convention/SKILL.md · Naming rules for Explainer Studio, covering verbs for functions, nouns for classes, booleans, maps, units…
git:20261014.bb251f8 · audit A · 3 stars
releasing SKILL.md skill
heptameta/heptabase-explainer-studio · .claude/skills/releasing/SKILL.md · How an Explainer Studio release is decided, prepared in a release pull request, and published by CI. Use when deciding…
git:20261014.722ad9d · audit A · 3 stars
AGENTS.md AGENTS.md file
heptameta/heptabase-explainer-studio · AGENTS.md
git:20261018.72088a1 · audit A · 3 stars
CLAUDE.md CLAUDE.md file
heptameta/heptabase-explainer-studio · CLAUDE.md
git:20261014.bb251f8 · audit B · 3 stars

Every file in heptameta/heptabase-explainer-studio

Browse by kind, by grade A, or by owner.