docs-website-update

Cherry-picks docs commits from master onto website and release branches in the nx repo.

29.3k|3.0k|Updated Aug 11, 2017
One-click install
npx skills add https://github.com/nrwl/nx --skill docs-website-update
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: docs-website-update
Source: https://github.com/nrwl/nx/tree/main/.claude/skills/docs-website-update
Command: npx skills add https://github.com/nrwl/nx --skill docs-website-update

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Docs commits merged to master in the nx repo do not automatically reach the branches that deploy nx.dev. This Skill syncs those commits onto both the live website branch and the current release branch, preventing the release pipeline from silently wiping out published documentation updates.

Core Features & Use Cases

  • Dual-branch sync: Cherry-picks docs( and feat(nx-dev) commits onto both website-<major> and the matching <major>.<minor>.x release branch.
  • Automatic branch detection: Identifies the highest website branch and its matching release branch using git ref queries.
  • Safe failure handling: Aborts conflicting cherry-picks, skips already-applied commits, and reports per-branch results without pushing.
  • Use Case: After several docs PRs merge to master, ask the assistant to update the docs website; it computes the delta since the last sync, cherry-picks the commits onto website-23 and 23.1.x, and reports which commits succeeded, were skipped, or failed.

Quick Start

Ask the assistant to update the docs website by cherry-picking the latest docs commits from master onto the website and release branches.

Frequently Asked Questions about docs-website-update

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I update the nx.dev docs website after merging docs PRs?

Docs commits merged to master must be cherry-picked onto the website-<major> branch and the matching release branch. This Skill detects both branches, builds the list of docs commits since the last sync, and cherry-picks them oldest to newest.

Why do docs commits need to go on two branches in the nx repo?

The website-<major> branch deploys nx.dev, but the release pipeline overwrites it from the <major>.<minor>.x release branch. If a commit only lands on the website branch, the next patch release wipes it out.

What happens when a cherry-pick conflicts on the release branch?

The Skill aborts the conflicting cherry-pick with git cherry-pick --abort, records the failed sha, and continues with the remaining commits. It never attempts to resolve conflicts and reports all failures at the end for manual handling.

Does this Skill push the updated branches to origin?

No, it never pushes. After cherry-picking, it prints a per-branch report and reminds you which branches have unpushed commits, showing the exact git push commands to run manually.

Can I run this Skill outside the nx repository?

No, it only works in the nx repo and stops immediately if run elsewhere. It also refuses to proceed if there are uncommitted or untracked files in the working tree.