Run any Skill in Manus with one click

create-wolfram-documentation

Stars0

Forks0

UpdatedJuly 3, 2026 at 00:37

Orchestrate publishable Wolfram Language documentation for a project or paclet - authored as literate-markdown (.md) and built into notebooks / ref pages with MarkdownToNotebook, using the family of Wolfram authoring skills hosted at github.com/WolframInstitute/MarkdownToNotebook. Use this whenever the user wants to document a Wolfram paclet or project, generate reference pages / a guide / tutorials / an overview / a computational essay for their Wolfram Language code, publish a Function/Data/Example/Prompt/Demonstration resource, port existing .nb documentation to markdown, or set up a Wolfram docs pipeline. This is the entry point for "/create-wolfram-documentation". It surveys the project, picks the right doc types, backs up existing .nb docs, ports them to .md, authors each page, and wires up the build.

Installation

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.

Run Skill in Manus

Source

WolframInstitute

WolframInstitute/MarkdownToNotebook

View GitHub Repository View Creator Repositories

Download

Run Skill in Manus

Related occupationsSOC

Based on SOC occupation classification

Software DevelopersComputer and Mathematical Occupations·SOC 15-1252

SKILL.md

readonly

More from this repository

same repository

wolfram-computational-essay

WolframInstitute/MarkdownToNotebook

Author a Wolfram Computational Essay (Stephen Wolfram's narrative-and-code notebook genre, published on the Notebook Archive or Wolfram Cloud) as a literate-markdown document and convert it to a publishable notebook with MarkdownToNotebook. Use this whenever the user wants to write, draft, or publish a Wolfram computational essay, a narrative notebook, an explanatory notebook combining prose and computation - especially when they would rather write markdown than hand-edit notebook cells. Also use it when asked to add abstract, byline, or sections to such an essay.

2026-07-030

wolfram-data-repository

WolframInstitute/MarkdownToNotebook

Author a Wolfram Data Repository resource (a curated dataset packaged with its statistical metadata, primary content, named accessors, and worked examples) as a literate-markdown document and convert it to the official definition notebook with MarkdownToNotebook. Use this whenever the user wants to create, write, draft, or publish a Wolfram Data Repository submission, a Data resource, a dataset accessible via ResourceData / WolframDataRepository, or anything that says `Template: Data` / `ResourceType: Data` - especially when they would rather write markdown than hand-edit notebook cells. Also use it when asked to add content elements, statistical metadata, or examples to such a resource.

2026-07-030

wolfram-demonstration

WolframInstitute/MarkdownToNotebook

Author a Wolfram Demonstration (a deployable interactive Manipulate-based visualization for the Wolfram Demonstrations Project) as a literate-markdown document and convert it to the official authoring notebook with MarkdownToNotebook. Use this whenever the user wants to create, write, draft, or publish a Wolfram Demonstration, an interactive Manipulate, an explorable visualization for demonstrations.wolfram.com - especially when they would rather write markdown than hand-edit notebook cells. Also use it when asked to add snapshots, caption, or metadata to such a Demonstration.

2026-07-030

wolfram-example-repository

WolframInstitute/MarkdownToNotebook

Author a Wolfram Example Repository resource (a deployable Example with named content elements and worked examples) as a literate-markdown document and convert it to the official definition notebook with MarkdownToNotebook. Use this whenever the user wants to create, write, draft, or publish a Wolfram Example Repository resource, an Example resource, a curated dataset or example notebook exposed via ResourceData - especially when they would rather write markdown than hand-edit notebook cells. Also use it when asked to add content elements, examples, or metadata to such a resource.

2026-07-030

wolfram-function-resource

WolframInstitute/MarkdownToNotebook

Author a Wolfram Function Repository resource (a deployable ResourceFunction) as a literate-markdown document and convert it to the official definition notebook with MarkdownToNotebook. Use this whenever the user wants to create, write, draft, or publish a Wolfram Language Function Repository function, a ResourceFunction, or a FunctionResource definition notebook - especially when they would rather write markdown than hand-edit notebook cells. Also use it when asked to add usage, examples, or metadata to such a function.

2026-07-030

wolfram-guide-page

WolframInstitute/MarkdownToNotebook

Author a Wolfram Language guide page (a paclet's documentation home page that lists its functions, like the built-in guide/ pages) as a literate-markdown document and build it with MarkdownToNotebook. Use this whenever the user wants to write or generate a guide page, a paclet landing/overview page, or a curated function index for a Wolfram paclet - rather than hand-editing the DocumentationTools guide authoring notebook.

2026-07-030

name

create-wolfram-documentation

description

Create Wolfram documentation

Turn a Wolfram Language project into publishable documentation authored as literate-markdown and built into notebooks / ref/ pages with MarkdownToNotebook. The markdown is the source of truth; the .nb are generated and gitignored. You never hand-edit notebook cell styles - you write .md and the converter fills the official templates.

This is an orchestrator. It does not itself contain the per-page conventions - those live in a family of focused authoring skills at the WI GitHub location. Your job is to survey the project, choose which doc types to create, and drive the right sub-skill for each, protecting the user's existing docs on the way.

The authoring skills (at the WI GitHub location)

Each doc type has its own skill under https://github.com/WolframInstitute/MarkdownToNotebook/blob/main/skills/<name>/SKILL.md. Before authoring a page of a given type, read that skill's SKILL.md - it carries the frontmatter, section contract, code-cell options, and build/check steps for that type. Prefer a local checkout of WolframInstitute/MarkdownToNotebook if one is on disk (look for a skills/ directory next to MarkdownToNotebook.wl); otherwise WebFetch the raw SKILL.md from GitHub.

Doc type	Skill	Use for
Paclet definition	`wolfram-paclet`	the paclet's `ResourceDefinition.nb` (metadata, hero image); the hub that the doc pages hang off
Symbol reference page	`wolfram-symbol-page`	one `ref/` page per exported/public symbol (Usage, Details, Examples, Scope)
Guide page	`wolfram-guide-page`	the paclet's landing page / curated function index (`guide/`)
Tech note / tutorial	`wolfram-tech-note`	a task- or concept-oriented tutorial (`tutorial/`)
Overview page	`wolfram-overview-page`	a navigable TOC index when the paclet has several guides / many pages
Computational essay	`wolfram-computational-essay`	a narrative prose-and-code notebook (Notebook Archive / Cloud), not a resource
Function Repository	`wolfram-function-resource`	a standalone deployable `ResourceFunction`
Data Repository	`wolfram-data-repository`	a curated dataset resource
Example Repository	`wolfram-example-repository`	an example/dataset resource with content elements
Prompt Repository	`wolfram-prompt`	an LLM persona / function / modifier prompt
Demonstration	`wolfram-demonstration`	an interactive `Manipulate` demonstration

Shared references (read as needed, same repo): docs/README.md (template map), docs/doc-pages.md (Symbol/Guide/TechNote conventions), docs/resource-notebooks.md (resource templates), docs/examples.md (the one-cell-per-demonstration rule), GUIDE.md (Wolfram Language code style).

Workflow

Run these in order. Confirm the plan with the user before generating files, and never destroy an existing .nb doc without backing it up first.

1. Survey the project

Find the paclet metadata: PacletInfo.wl / PacletInfo.m - read Name, Version, the context(s), and the Documentation extension.
Find the source: Kernel/*.wl (or *.m). Enumerate the public/exported symbols (usage messages, `Package` exports, or symbols with ::usage) - these become symbol pages.
Find existing docs: Documentation/English/**/*.nb, a root ResourceDefinition.nb, README*, docs/, tutorials, papers.
Decide the publish target: a paclet (ref/guide/tutorial pages), a standalone resource (Function/Data/Example/Prompt/Demonstration), or a computational essay. A project can want several.

2. Propose the doc set

Map the survey to concrete pages and confirm with the user (AskUserQuestion if the scope is ambiguous). A typical paclet:

1 paclet definition (wolfram-paclet) if publishing to the Paclet Repository.
1 guide page (wolfram-guide-page) listing the functions.
1 symbol page per public symbol (wolfram-symbol-page).
Tech notes for the main workflows (wolfram-tech-note).
An overview page (wolfram-overview-page) if there is more than one guide or a large symbol set.

3. Back up existing `.nb` docs (do this BEFORE anything else)

If the project already has notebook docs, copy them somewhere safe first:

ts=$(date +%Y%m%d-%H%M%S)
mkdir -p "docs-backup-$ts"
# copy every generated/authored notebook out of harm's way
rsync -a --prune-empty-dirs --include='*/' --include='*.nb' --exclude='*' \
      Documentation "docs-backup-$ts/" 2>/dev/null
cp -f ResourceDefinition.nb "docs-backup-$ts/" 2>/dev/null || true

Tell the user where the backup went. Add the generated .nb output paths to .gitignore (the .md is the source of truth; the .nb are rebuilt).

4. Port existing docs to `.md` (offer this)

If there are existing .nb docs, offer to port them to markdown so the project switches to the markdown-as-source workflow rather than starting from a blank page. Use the inverse converter, NotebookToMarkdown (the round-trip twin of MarkdownToNotebook), then refine the result against the matching authoring skill:

Get["NotebookToMarkdown.wl"];  (* from a WolframInstitute/MarkdownToNotebook checkout *)
Export["docs/Symbols/Foo.md", NotebookToMarkdown[Import["Documentation/English/ReferencePages/Symbols/Foo.nb"]], "Text"]

Non-notebook docs (a README, a paper, doc comments) are ported by hand into the appropriate .md template. Always diff the ported .md against the backup so nothing is silently dropped.

5. Author each page

For each planned page, read the matching sub-skill's SKILL.md, then write the .md under docs/ (mirroring the paclet layout: docs/Symbols/, docs/Guides/, docs/Tutorials/, root ResourceDefinition.md). Follow that skill exactly for frontmatter, the [Symbol]() / `code` link split, the one-cell-per-demonstration rule, and  expected-result hints.

6. Wire up the build

Add a build.wls that loads MarkdownToNotebook and converts each docs/*.md into the paclet's Documentation/English/… layout (keyed by the frontmatter Template). Load the converter from its public cloud deployment (it is not on the public Function Repository yet):

mtn = ResourceFunction[ResourceObject[
    "https://www.wolframcloud.com/obj/nikm/DeployedResources/Function/MarkdownToNotebook"]];
PacletDirectoryLoad[pacletDir]; Needs["Publisher`PacletName`"];  (* so example cells resolve symbols *)
mtn[srcMd, outNb];

(If a local checkout of the repo is on disk, Get["MarkdownToNotebook.wl"] instead - it always reflects the latest fixes.) Model build.wls on an existing paclet's, e.g. TuringMachine's.

7. Build, then DocumentationBuild, then verify

Run wolframscript -f build.wls. For doc pages (Symbol/Guide/TechNote/ Overview), the mtn output is an authoring notebook - run DocumentationBuild on it before deploying/scraping, or the published page shows a double section rule between Details and Examples and folds examples under "Examples Initialization" (the authoring ExamplesInitializationSection is only collapsed into the Examples section at build time). A pipeline that deploys the raw authoring .nb will look wrong; add a DocumentationBuild stage before the scrape. Open a built page and confirm the Examples render as their own section.

Guardrails

Backup before generate. Step 3 is not optional if .nb docs exist.
Markdown is the source. Generated .nb are gitignored; re-author the .md and rebuild, never hand-edit the notebook.
One demonstration per code cell. No two unrelated computations in one wl cell (see docs/examples.md).
No Needs[...] in example cells on doc pages - the page's context is loaded for you; put extra contexts in a ContextPath: frontmatter key.
Read the sub-skill first for each page type; this orchestrator only routes - the real conventions live in those skills.

create-wolfram-documentation

More from this repository

More from this repository

Create Wolfram documentation

The authoring skills (at the WI GitHub location)

Workflow

1. Survey the project

2. Propose the doc set

3. Back up existing .nb docs (do this BEFORE anything else)

4. Port existing docs to .md (offer this)

5. Author each page

6. Wire up the build

7. Build, then DocumentationBuild, then verify

Guardrails

Create Wolfram documentation

The authoring skills (at the WI GitHub location)

Workflow

1. Survey the project

2. Propose the doc set

3. Back up existing .nb docs (do this BEFORE anything else)

4. Port existing docs to .md (offer this)

5. Author each page

6. Wire up the build

7. Build, then DocumentationBuild, then verify

Guardrails

3. Back up existing `.nb` docs (do this BEFORE anything else)

4. Port existing docs to `.md` (offer this)

3. Back up existing `.nb` docs (do this BEFORE anything else)

4. Port existing docs to `.md` (offer this)