New: 97,000+ skills indexed from GitHub repos with 100+ stars · every skill safety-checkedBrowse top skillsTop skills
Esc to closeBrowse all skills
Submit a skillBrowse skills
Submit a skillBrowse skills

Agent skill

Docs Sync

by joselado in joselado/dmrgpy

Update docs/userguide.{md,tex} and docs/documentation.{md,tex} together after a change to dmrgpy, keeping the Markdown and LaTeX versions of each in step and verifying the .tex still compiles under…

GPL-3.0Auto-check passedDocuments & Office

Install Docs Sync

skills CLI
$ npx skills add joselado/dmrgpy --skill docs-sync -a claude-code

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

GitHub CLI
$ gh skill install joselado/dmrgpy docs-sync --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/joselado/dmrgpy.git skills-src && mkdir -p .claude/skills && cp -r skills-src/.claude/skills/docs-sync .claude/skills/docs-sync && 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
docs-sync
GitHub stars
114
Token cost
~926 tokens
SKILL.md length
457 words
Files
1
Skills in repo
3
Repo updated
First seen
Licence
GPL-3.0

At a glance

Update docs/userguide.{md,tex} and docs/documentation.{md,tex} together after a change to dmrgpy, keeping the Markdown and LaTeX versions of each in step and verifying the .tex still compiles under…

  • Asks to document something
  • SKILL.md covers The two formats are one document, Compile before declaring it done and What a section should say
  • Instructions only: no scripts, shell commands, URLs or credentials in SKILL.md
  • Update the user guide

What it does

Docs Sync is an agent skill from joselado/dmrgpy. Update docs/userguide.{md,tex} and docs/documentation.{md,tex} together after a change to dmrgpy, keeping the Markdown and LaTeX versions of each in step and verifying the .tex still compiles under pdflatex. Use this whenever a feature, method, submode, backend behaviour or dispatch rule has just landed or changed, whenever the user asks to document something or to update the user guide, and whenever a doc section is suspected of having drifted from the code. Forgetting the .tex half is the standard failure here…

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

It sits in Documents & Office, covering LaTeX and Technical writing. It works with LaTeX. The repository describes itself as: DMRGPy is a Python library to compute quasi-one-dimensional spin chains and fermionic systems using matrix product states with DMRG as implemented in ITensor. Most of the… The licence is GPL-3.0.

When your agent uses it

  • Asks to document something
  • Update the user guide
  • Whenever a doc section is suspected of having drifted from the code

Example prompts

  • “/docs-sync”

What it can do on your machine

Read from SKILL.md and the folder at commit 7373fce. 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

    No scripts in the folder and no shell commands in SKILL.md (its code samples are bash).

    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

Docs Sync loads about 926 tokens when it runs. Until then it costs about 145 tokens; SKILL.md has 457 words of instructions outside code blocks.

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

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 joselado/dmrgpy at commit 7373fce, republished under its GPL-3.0 licence (© joselado). 457 words, ~926 tokens.

Download SKILL.mdSave it as .claude/skills/docs-sync/SKILL.md (or your agent's skills folder).
name
docs-sync
description
Update docs/user_guide.{md,tex} and docs/documentation.{md,tex} together after a change to dmrgpy, keeping the Markdown and LaTeX versions of each in step and verifying the .tex still compiles under pdflatex. Use this whenever a feature, method, submode, backend behaviour or dispatch rule has just landed or changed, whenever the user asks to document something or to update the user guide, and whenever a doc section is suspected of having drifted from the code. Forgetting the .tex half is the standard failure here, and it is invisible until someone rebuilds the PDF.

Keeping the documentation in step

Four files, two documents, two formats each:

  • docs/user_guide.{md,tex} is physics-facing. What calculation each method performs, the formula behind it, the arguments that matter and what to look for in the result. A new model, a new Many_Body_Chain method, a new dynamical-correlator submode, a new post-processing tool all land here.
  • docs/documentation.{md,tex} is architecture-facing. Backends, dispatch, directory layout, the conventions a later change has to respect. A change that only moves numbers does not belong here; a change to which backend answers which call does.

Decide which document the change belongs in before writing anything. Many changes belong in the user guide alone.

The two formats are one document

The .md and the .tex carry the same content in the same order under the same section names, and they drift silently because the .md is the one people read in the repository and the .tex is only noticed when the PDF is rebuilt.

Write the .md first, then port the same text into the .tex, matching the section it belongs to rather than appending at the end. Cheap checks that the two are still in step:

bash
grep -n '^## ' docs/user_guide.md                    # sections, in order
grep -n '\\section' docs/user_guide.tex              # the same list, same order
grep -c '<what you just added>' docs/user_guide.md docs/user_guide.tex

Match the starred forms too (\subsection*{...}), or a section that is present reads as missing.

Translating as you go: a fenced code block becomes lstlisting, inline code becomes \texttt{}, and mathematics is written properly in both, $t_2=0.2$ in the Markdown and the same in the LaTeX rather than left as plain text. Underscores, ampersands, percent signs and carets in prose have to be escaped in the .tex, which is the usual cause of a build that was fine yesterday.

Show full SKILL.md (189 more words)Show less

Compile before declaring it done

bash
cd docs && pdflatex -interaction=nonstopmode <whichever you edited>.tex

Run it twice when the table of contents or a reference moved. It has to come out with no errors, and ideally with no overfull-hbox warnings, which in practice come from a long code line or an unbroken identifier in prose. Read the log rather than trusting the exit status.

What a section should say

The house shape, and the reason the guide reads the way it does: open with one sentence saying what we will now see, give the physics before the code, then read the result aloud afterwards, saying what to look for in the arrays rather than promising a figure. Tie the quantity to what measures it in a clause, be specific about approximations, and point at the example under examples/ that runs it. An argument list is a catalogue, one bullet per argument, what it buys you and when to reach for it.

Where the change moved numbers rather than behaviour, say so in the same terms the audit records use: which calls, how large, and that results from before are not comparable. docs/user_guide.md's closing section is where that lives.

© joselado, GPL-3.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/docs-sync of joselado/dmrgpy.

Open the folder on GitHubat commit 7373fce

Compare with similar skills

Docs Sync 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.

Docs Sync compared with similar skills
SkillStarsUsed inTokensAuto-checkLicenceRepo updated
Docs Sync this skilljoselado/dmrgpy114—~926Automated safety check: PassGPL-3.0
Research Writingalfonso0512/research-writing-skill4861 repos~818Automated safety check: PassMIT
Paper WritingMLNLP-World/Paper-Writing-Tips4.7k—~630Automated safety check: PassNone
Evomath TaoEvoScientist/EvoSkills4742 repos~3.8kAutomated safety check: PassApache-2.0
PaperjurySpark-To-Paper-Skills/paperjury1.2k—~5.3kAutomated safety check: PassMIT
Thesis Defense PPTX Builderzouchenzhen/thesis-defense-pptx-skill266—~2.4kAutomated safety check: PassApache-2.0

Similar skills

  • Research Writing

    alfonso0512/research-writing-skill

    科研论文写作助手，提供 30 个 Prompt 模板覆盖论文写作全流程. An agent skill from alfonso0512/research-writing-skill.

    486 GitHub starsUsed in 1 repo~818 tokens
    Documents & OfficeAuto-check passed

  • Paper Writing

    MLNLP-World/Paper-Writing-Tips

    学术论文写作检查与优化助手。基于 MLNLP-World 社区整理的论文写作技巧，帮助检查和优化学术论文。Use when: (1) 检查论文 LaTeX 格式和排版, (2) 优化公式符号使用, (3) 改进图表设计, (4) 润色英文学术表达, (5) 检查参考文献格式, (6) 投稿前终稿检查, (7) 用户询问论文写作技巧或规范。

    4.7k GitHub stars~630 tokensUpdated 11 days ago
    Documents & OfficeAuto-check passed

  • Evomath Tao

    EvoScientist/EvoSkills

    A skill your agent uses whenever the user submits a non-trivial mathematical claim that needs a rigorous proof or audit.

    474 GitHub starsUsed in 2 repos~3.8k tokens
    Documents & OfficeAuto-check passed

  • Paperjury

    Spark-To-Paper-Skills/paperjury

    Three modes for CS-conference papers (CVPR/ICCV/ECCV vision, ACL/EMNLP/NAACL NLP, ICLR/NeurIPS/ICML/AAAI ML).

    1.2k GitHub stars~5.3k tokensUpdated 1 mo ago
    Documents & OfficeAuto-check passed

  • Thesis Defense PPTX Builder

    zouchenzhen/thesis-defense-pptx-skill

    Builds an editable thesis defense PowerPoint from a thesis PDF or LaTeX project while preserving a supplied university or lab template, then runs a visual quality check.

    266 GitHub stars~2.4k tokensUpdated 4 mo ago
    Documents & OfficeAuto-check passed

  • Mathmodel Skill

    handsomeZR-netizen/mathmodel-skill

    CUMCM 国赛、MCM/ICM 美赛与电工杯数学建模竞赛的端到端协作工作流。Use when a user explicitly works on one of these modeling contests or asks to run/review a modeling-competition paper from problem selection through modeling…

    292 GitHub stars~2.5k tokensUpdated 11 days ago
    Documents & OfficeAuto-check passed

More from joselado/dmrgpy

  • Hole Hunt

    joselado/dmrgpy

    Run a multi-lens hole hunt (audit) of the dmrgpy Python layer, or add a lens, a finding or a fix cluster to an existing one.

    114 GitHub stars~3.4k tokensUpdated 11 days ago
    Auto-check passed

  • New Example

    joselado/dmrgpy

    Add or revise a script under examples/ in dmrgpy. An agent skill from joselado/dmrgpy.

    114 GitHub stars~1.2k tokensUpdated 11 days ago
    Auto-check passed

Works with

Categories

Questions about Docs Sync

What does Docs Sync do?

Update docs/userguide.{md,tex} and docs/documentation.{md,tex} together after a change to dmrgpy, keeping the Markdown and LaTeX versions of each in step and verifying the .tex still compiles under…. Docs Sync is an agent skill from joselado/dmrgpy.tex still compiles under pdflatex.

When should I use Docs Sync?

Docs Sync fits situations like: asks to document something; update the user guide; whenever a doc section is suspected of having drifted from the code.

How do I install Docs Sync in Claude Code?

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

How do I install Docs Sync in Codex?

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

Can I use Docs Sync 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 joselado/dmrgpy --skill docs-sync -a cursor` (or -a gemini-cli, github-copilot or opencode for the others). To copy it by hand, put the folder in .cursor/skills/docs-sync, .gemini/skills/docs-sync, .github/skills/docs-sync and .opencode/skills/docs-sync in your project.

What does Docs Sync need to run?

SKILL.md names no scripts, command-line tools or credentials: Docs Sync is instructions for the agent only.

Does Docs Sync 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 Docs Sync 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 Docs Sync use?

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

How many tokens does Docs Sync use?

About 926 tokens (SKILL.md is roughly 3.7k 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 Docs Sync?

Skills that share tags, products or a category with Docs Sync: Research Writing (alfonso0512/research-writing-skill, 486 stars), Paper Writing (MLNLP-World/Paper-Writing-Tips, 4.7k stars), Evomath Tao (EvoScientist/EvoSkills, 474 stars) and Paperjury (Spark-To-Paper-Skills/paperjury, 1.2k stars). The comparison table on this page puts their stars, adoption, token cost, safety result and licence side by side.

Who maintains Docs Sync?

joselado (a GitHub user) maintains it in joselado/dmrgpy, which has 114 GitHub stars. The repository holds 3 skills in this directory. The repository was last updated on September 26, 2026.

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