j-doc-sync

Name: j-doc-sync
Author: jlaws

Post-ship documentation sync — discover and fix stale docs after shipping changes. Use when docs may be out of date after a release or feature merge. Do NOT use for writing new docs from scratch (use

by jlaws(0) 0 installs

Free

Free account. Installing gives you the manifest plus copy-paste snippets.

See reviews

About

Prompt file imported from jlaws/dotfiles (.codex/prompts/j-doc-sync.md). Fill in {{arguments}} before use. Copyright stays with the author.

Invoke the post-ship-doc-sync skill before doing anything else. Sync documentation with recent code changes.

Resolve the scope in this order:

If arguments are provided, use them: {{arguments}}
Else, check for a current PR: gh pr view --json number,url,baseRefName,headRefName. If one exists, review it (gh pr diff) and treat its full change set as the scope (origin/<baseRefName>...HEAD) — update docs/ and every README.md to reflect all changes made in the PR.
Else, default to $(git describe --tags --abbrev=0)..HEAD.

For substantial rewrites, you may delegate to the documentation-writer agent (loads .agents/references/documentation/). Verify its output before committing.

Use it

Copy one of these into your project. Installing also returns the manifest and these snippets.

Invoke the `post-ship-doc-sync` skill before doing anything else. Sync documentation with recent code changes.

Resolve the scope in this order:
1. If arguments are provided, use them: {{arguments}}
2. Else, check for a current PR: `gh pr view --json number,url,baseRefName,headRefName`. If one exists, review it (`gh pr diff`) and treat its full change set as the scope (`origin/<baseRefName>...HEAD`) — update `docs/` and every README.md to reflect all changes made in the PR.
3. Else, default to `$(git describe --tags --abbrev=0)..HEAD`.

For substantial rewrites, you may delegate to the `documentation-writer` agent (loads `.agents/references/documentation/`). Verify its output before committing.

Manifest

The prompt text and its fill-in variables. Copy it or fetch it by URL from your own code.

jlaws-dotfiles-j-doc-sync-codex-prompt.prompt.jsonjson

{
  "prompt": "Invoke the `post-ship-doc-sync` skill before doing anything else. Sync documentation with recent code changes.\n\nResolve the scope in this order:\n1. If arguments are provided, use them: {{arguments}}\n2. Else, check for a current PR: `gh pr view --json number,url,baseRefName,headRefName`. If one exists, review it (`gh pr diff`) and treat its full change set as the scope (`origin/<baseRefName>...HEAD`) — update `docs/` and every README.md to reflect all changes made in the PR.\n3. Else, default to `$(git describe --tags --abbrev=0)..HEAD`.\n\nFor substantial rewrites, you may delegate to the `documentation-writer` agent (loads `.agents/references/documentation/`). Verify its output before committing.",
  "variables": [
    "arguments"
  ],
  "notes": "Post-ship documentation sync — discover and fix stale docs after shipping changes. Use when docs may be out of date after a release or feature merge. Do NOT use for writing new docs from scratch (use $cmd-j-docs instead). Arguments: <branch, tag range, or 'since last release'>.",
  "metadata": {
    "source": {
      "provider": "github-codex-prompts",
      "repository": "https://github.com/jlaws/dotfiles",
      "path": ".codex/prompts/j-doc-sync.md",
      "ref": "db660e0f4380ab20a69c7c70495f235e49df2a0a",
      "url": "https://github.com/jlaws/dotfiles/blob/db660e0f4380ab20a69c7c70495f235e49df2a0a/.codex/prompts/j-doc-sync.md",
      "key": "jlaws/dotfiles/.codex/prompts/j-doc-sync.md"
    }
  }
}

Fetch it by URL: GET /api/v1/registry/jlaws-dotfiles-j-doc-sync-codex-prompt/manifest?version=1.0.0

About

Use it

Manifest

Reviews