Agent skill

Update Docs

by michelangelo-ai in michelangelo-ai/michelangelo

Update Michelangelo documentation. An agent skill from michelangelo-ai/michelangelo.

Apache-2.0Auto-check passed

Install Update Docs

skills CLI
$ npx skills add michelangelo-ai/michelangelo --skill update-docs -a claude-code

Project install by default; add -g for ~/.claude/skills/.

GitHub CLI
$ gh skill install michelangelo-ai/michelangelo update-docs --agent claude-code

Project scope by default; add --scope user for a personal install. Needs GitHub CLI 2.90.0 or later (public preview).

Manual copy
$ git clone --depth 1 https://github.com/michelangelo-ai/michelangelo.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/update-docs .claude/skills/update-docs && rm -rf skills-src

Use ~/.claude/skills/ instead of .claude/skills for a personal install. The folder must contain SKILL.md.

Claude Code skills documentation · loads skills from .claude/skills/

Facts

Skill name
update-docs
GitHub stars
116
Token cost
~1.6k tokens
SKILL.md length
463 words
Files
1
Skills in repo
9
Repo updated
First seen
Licence
Apache-2.0

At a glance

Update Michelangelo documentation. An agent skill from michelangelo-ai/michelangelo.

  • Works in 4 steps: Create file in appropriate folder with… → Add frontmatter if you need specific… → Add # Title as first line → …
  • Fixing docs in the docs/ folder
  • SKILL.md covers Documentation Structure, File Naming, Page Titles and Page Frontmatter, plus 10 more sections
  • Calls bun

What it does

Update Docs is an agent skill from michelangelo-ai/michelangelo. Update Michelangelo documentation. Use when adding, modifying, or fixing docs in the docs/ folder. Ensures consistent formatting, proper titles, and valid links.

Its SKILL.md is about 1.6k tokens, which your agent loads only when the skill is triggered. It is a single SKILL.md file with no bundled scripts.

The repository describes itself as: Michelangelo AI: Uber's end-to-end machine learning platform. The licence is Apache-2.0.

When your agent uses it

  • Fixing docs in the docs/ folder

Example prompts

  • “/update-docs”

Requirements

  • Python 3

Workflow steps

4 steps, taken from the first numbered list in SKILL.md.

  1. Create file in appropriate folder with lowercase-kebab name
  2. Add frontmatter if you need specific ordering
  3. Add # Title as first line
  4. Page auto-appears in sidebar

What it can do on your machine

Read from SKILL.md and the folder at commit fa9c827. It shows what the files ask for, not the result of running them.

  • Tool permissions

    Pre-approves nothing: there is no allowed-tools line, so your agent's usual permission prompts apply.

    From allowed-tools in the SKILL.md frontmatter.

  • Runs code

    Shell commands in SKILL.md call:

    • bun

    From the folder's file list and the shell code blocks in SKILL.md.

  • Network

    No URLs in SKILL.md.

    From URLs in SKILL.md, links to its own repository left out.

  • Credentials

    Names no API keys, tokens, secrets or passwords.

    From names ending in _API_KEY, _TOKEN, _SECRET, _KEY or _PASSWORD in SKILL.md.

Context cost

Update Docs loads about 1.6k tokens when it runs. Until then it costs about 43 tokens; SKILL.md has 463 words of instructions outside code blocks.

Always · name and description, kept in context so the agent knows when to use it
~43
When it runs · the whole SKILL.md, loaded when a task matches
~1.6k

Estimates: characters ÷ 4, the usual rule of thumb; real counts depend on the model's tokenizer. Scripts and assets cost tokens only if the agent reads them.

Safety

Auto-check passed

The automated check found no risky patterns in SKILL.md.

Automated static check — not a guarantee. Review scripts before installing. It scans the text of SKILL.md for risky patterns (piping downloads into a shell, reading credential files, hidden Unicode, destructive commands); files beside SKILL.md are not scanned.

SKILL.md

The full file from michelangelo-ai/michelangelo at commit fa9c827, republished under its Apache-2.0 licence (© michelangelo-ai). 463 words, ~1,571 tokens.

Download SKILL.mdSave it as .claude/skills/update-docs/SKILL.md (or your agent's skills folder).
name
update-docs
description
Update Michelangelo documentation. Use when adding, modifying, or fixing docs in the docs/ folder. Ensures consistent formatting, proper titles, and valid links.
user-invocable
true

Michelangelo Documentation Updater

You are updating the Michelangelo documentation site (Docusaurus v3 + Bun).

Documentation Structure

docs/
├── intro.md                    # Landing page (/)
├── images/                     # Shared images
├── about/                      # Platform overview
├── contributing/               # Developer guides
├── dev/                        # Development docs
│   └── go/                     # Go development
├── operator-guides/            # Platform operator docs
│   ├── jobs/                   # Job system docs
│   └── ui/                     # UI docs
│       └── configuration/      # UI config reference
├── setup-guide/                # Installation guides
└── user-guides/                # End-user tutorials
    └── ml-pipelines/           # ML pipeline guides

File Naming

  • Always use lowercase-kebab-case: my-new-guide.md
  • This creates clean URLs: /user-guides/my-new-guide
  • Never use spaces, underscores, or capital letters in filenames

Page Titles

Every page MUST start with a proper # Title:

markdown
# Descriptive Page Title

Content starts here...

Bad titles to avoid:

  • # Introduction (too generic)
  • # Overview (too generic)
  • # 1. Introduction (numbered page titles are bad - save numbers for sub-sections)
  • # overview / Introduction (template artifact)

Numbered sub-sections are OK for tutorial steps after the title:

markdown
# My Tutorial

Introduction paragraph...

## 1. First Step
## 2. Second Step

Page Frontmatter

Use YAML frontmatter at the top of pages to control sidebar order and display:

markdown
---
sidebar_position: 1
sidebar_label: "Short Label"
slug: /custom-url
---

# Full Page Title

Content...
FieldPurpose
sidebar_positionOrder in sidebar (1, 2, 3...)
sidebar_labelShorter name for sidebar
slugCustom URL path
titleSEO/browser tab title (defaults to # heading)

Adding New Pages

  1. Create file in appropriate folder with lowercase-kebab name
  2. Add frontmatter if you need specific ordering
  3. Add # Title as first line
  4. Page auto-appears in sidebar

Adding New Sections

Create a folder with _category_.json:

json
{
  "label": "Section Name",
  "position": 5,
  "collapsed": false
}

Images

Place in docs/images/ or co-locate with docs:

markdown
![Alt text](../images/my-image.png)

Validation

After making changes, always run:

bash
cd website && bun run build

This catches:

  • Broken internal links
  • Invalid markdown
  • Missing files

Common Fixes

Fix missing title
markdown
# Proper Title Here

First paragraph of content...
Fix template headings

Change # 1. overview / Introduction to # Actual Title

Update paths after file renames:

markdown
[Link text](./correct-path.md)

Use relative paths for internal links:

markdown
[Link text](./sibling-page.md)
[Link text](../other-section/page.md)
  • Always use .md extension in links (Docusaurus converts them)
  • Relative paths ensure links work in both GitHub and the built site
  • Avoid absolute paths like /docs/page unless linking from non-docs content

Admonitions

Use Docusaurus admonitions for callouts:

markdown
:::note
Helpful information the reader should know.
:::

:::tip
Suggestions to help the reader be more successful.
:::

:::info
Additional context or background information.
:::

:::warning
Potential issues or gotchas.
:::

:::danger
Critical information about destructive actions.
:::

Style Guidelines

  • Use bold for UI elements and emphasis
  • Use backticks for code, commands, filenames
  • Use admonitions for notes, tips, and warnings
  • Use tables for feature comparisons
  • Keep paragraphs short (3-5 sentences max)
  • Use bullet lists for features, numbered lists for steps
Show full SKILL.md (171 more words)Show less

Reviewing Documentation

When reviewing docs someone else wrote, check for:

  1. Title - Is it descriptive? Not generic like "Introduction" or "Overview"?
  2. Filename - Is it lowercase-kebab-case?
  3. Frontmatter - Does it have sidebar_position if ordering matters?
  4. Structure - Does it have a logical flow? Intro → Details → Examples?
  5. Code examples - Are they complete and runnable?
  6. Links - Do internal links use correct relative paths?
  7. Images - Are they in docs/images/ with relative paths?

Run cd website && bun run build to catch broken links.

Generating Docs from Code

When asked to document code or verify docs match code:

  1. Read the source code first - understand what it actually does
  2. Check existing docs - see what's already documented
  3. Compare - identify gaps or inaccuracies
  4. Update docs to match the code, not the other way around
Key code locations
ComponentCode LocationDocs Location
Python SDKpython/docs/user-guides/
CLI toolspython/docs/user-guides/reference/cli.md
Go API servergo/docs/operator-guides/
UI componentsjavascript/docs/operator-guides/ui/
Documentation patterns for code

For Python functions/classes:

markdown
## FunctionName

Description of what it does.

**Parameters:**
- `param1` (type): Description
- `param2` (type, optional): Description. Default: `value`

**Returns:**
- (type): Description

**Example:**
\`\`\`python
result = function_name(param1, param2)
\`\`\`

For CLI commands:

markdown
## command-name

Description of what the command does.

\`\`\`bash
ma command-name [options] <required-arg>
\`\`\`

**Options:**
| Flag | Description |
|------|-------------|
| `--flag` | What it does |

**Examples:**
\`\`\`bash
ma command-name --flag value
\`\`\`

For API endpoints:

markdown
## EndpointName

**Request:**
\`\`\`protobuf
message RequestType {
  string field = 1;
}
\`\`\`

**Response:**
\`\`\`protobuf
message ResponseType {
  string result = 1;
}
\`\`\`

© michelangelo-ai, Apache-2.0. Rendered from Markdown: HTML in the file is shown as text, images as links, and headings moved down two levels. Raw file

Files

Just SKILL.md in .claude/skills/update-docs of michelangelo-ai/michelangelo.

Open the folder on GitHubat commit fa9c827

Compare with similar skills

Update Docs next to the 5 skills that share the most tags, products or categories with it. Stars are the repository's; “used in” counts other GitHub owners with a copy.

Update Docs compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Update Docs this skillmichelangelo-ai/michelangelo116—~1.6kAutomated safety check: PassApache-2.0
Fixalirezarezvani/claude-skills28k1 repos~765Automated safety check: PassMIT
Fix Issuepytorch/pytorch104k—~2.3kAutomated safety check: PassCustom licence
Orch Fix Defectaffaan-m/ECC275k1 repos~414Automated safety check: PassMIT
Logic Fix Allsickn33/agentic-awesome-skills47k1 repos~1.3kAutomated safety check: PassMIT
Fixdavepoon/buildwithclaude3.6k—~14kAutomated safety check: NotesMIT

Similar skills

  • Fix

    alirezarezvani/claude-skills

    Fix failing or flaky Playwright tests. An agent skill from alirezarezvani/claude-skills.

    28k GitHub starsUsed in 1 repo~765 tokens
    Testing & QAAuto-check passed
  • Fix Issue

    pytorch/pytorch

    Fix bugs reported in PyTorch GitHub issues by reproducing, root-causing, and implementing a fix in the local working tree.

    104k GitHub stars~2.3k tokensUpdated today
    AI & LLM EngineeringAuto-check passed
  • Orch Fix Defect

    affaan-m/ECC

    Orchestrate fixing a bug — reproduce it as a failing regression test, fix to green, review, and gated commit — by delegating each phase to the matching ECC agent.

    275k GitHub starsUsed in 1 repo~414 tokens
    Testing & QAAuto-check passed
  • Logic Fix All

    sickn33/agentic-awesome-skills

    Autonomous repository-wide audit-and-fix pipeline: health → review → locate/explain → fix → diff-verify → iterate until clean.

    47k GitHub starsUsed in 1 repo~1.3k tokens
    Auto-check passed
  • Fix

    davepoon/buildwithclaude

    Get fix intelligence for a vulnerability and propose concrete remediation for the current repository

    3.6k GitHub stars~14k tokensUpdated 2 days ago
    Data & AnalyticsAuto-check: notes
  • Fix Dependabot

    remotion-dev/remotion

    Official

    Fix a Dependabot PR by updating all monorepo instances of the dependency, running bun install, and pushing

    62k GitHub stars~509 tokensUpdated today
    DevelopmentAuto-check passed

More from michelangelo-ai/michelangelo

All 9 skills in this repo
  • Ma Sandbox Debug

    michelangelo-ai/michelangelo

    Tail logs, inspect pods, and diagnose unhealthy services in a running Michelangelo sandbox.

    116 GitHub stars~1k tokensUpdated today
    Auto-check passed
  • Ma Sandbox Deploy

    michelangelo-ai/michelangelo

    Build a Go service binary, package it into a Docker image, import into k3d, and deploy via helm sync.

    116 GitHub stars~1.4k tokensUpdated today
    Auto-check passed
  • Ma Sandbox Setup

    michelangelo-ai/michelangelo

    Canonical setup sequence for the Michelangelo local sandbox.

    116 GitHub stars~936 tokensUpdated today
    Auto-check passed
  • Ma Sandbox Test Plan

    michelangelo-ai/michelangelo

    Build, test, and verify a sandbox change across Go, JS, and Python.

    116 GitHub stars~2k tokensUpdated today
    Auto-check passed
  • Ma Design Interview

    michelangelo-ai/michelangelo

    Structured interview for designing and implementing changes to the Michelangelo platform.

    116 GitHub stars~2.2k tokensUpdated today
    Auto-check passed
  • Ma Sandbox Reset

    michelangelo-ai/michelangelo

    Tear down the Michelangelo sandbox cluster and recreate it from scratch.

    116 GitHub stars~312 tokensUpdated today
    Auto-check passed

Questions about Update Docs

What does Update Docs do?

Update Michelangelo documentation. An agent skill from michelangelo-ai/michelangelo. Update Docs is an agent skill from michelangelo-ai/michelangelo. Update Michelangelo documentation.

When should I use Update Docs?

Update Docs fits situations like: fixing docs in the docs/ folder.

How do I install Update Docs in Claude Code?

Run `npx skills add michelangelo-ai/michelangelo --skill update-docs -a claude-code`. Or copy the skill folder (.claude/skills/update-docs in michelangelo-ai/michelangelo) into .claude/skills/update-docs in your project. Claude Code loads it when a task matches its description.

How do I install Update Docs in Codex?

Run `npx skills add michelangelo-ai/michelangelo --skill update-docs -a codex`. Or copy the skill folder (.claude/skills/update-docs in michelangelo-ai/michelangelo) into .agents/skills/update-docs in your project. Codex loads it when a task matches its description.

Can I use Update Docs in Cursor, Gemini CLI or GitHub Copilot?

Cursor, Gemini CLI, GitHub Copilot and OpenCode also load SKILL.md folders. With the skills CLI, run `npx skills add michelangelo-ai/michelangelo --skill update-docs -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/update-docs, .gemini/skills/update-docs, .github/skills/update-docs and .opencode/skills/update-docs in your project.

What does Update Docs need to run?

Going by SKILL.md and its folder, Update Docs needs the command-line tools its instructions call (bun). Our summary lists: Python 3.

Does Update Docs access the network?

SKILL.md contains no URLs. Any network use would come from the scripts or tools the agent runs. This is read from the text; nothing was executed.

Is Update Docs safe to install?

Our automated static check of SKILL.md found no risky patterns, such as piping downloads into a shell, reading credential files or hidden Unicode. It is not a guarantee. Review the folder before installing.

What licence does Update Docs use?

Update Docs is published under the Apache-2.0 licence (the repository's licence). It allows redistribution, so the full SKILL.md is shown on this page.

How many tokens does Update Docs use?

About 1.6k tokens (SKILL.md is roughly 6.3k characters). Agents keep only the skill's name and description in context until a task matches; then they load SKILL.md in full.

What are the alternatives to Update Docs?

Skills that share tags, products or a category with Update Docs: Fix (alirezarezvani/claude-skills, 28k stars), Fix Issue (pytorch/pytorch, 104k stars), Orch Fix Defect (affaan-m/ECC, 275k stars) and Logic Fix All (sickn33/agentic-awesome-skills, 47k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Update Docs?

michelangelo-ai (a GitHub organization) maintains it in michelangelo-ai/michelangelo, which has 116 GitHub stars. The repository holds 9 skills in this directory. The repository was last updated on October 7, 2026.

Source: michelangelo-ai/michelangelo on GitHub. Facts on this page come from the repository at the commit we read; the author's words are quoted as theirs.