refactor(stacks): extract shared install snippets into partials#11826
refactor(stacks): extract shared install snippets into partials#11826jd wants to merge 1 commit into
Conversation
|
This pull request is part of a Mergify stack:
|
Merge Protections🔴 2 of 5 protections blocking · waiting on 👀 reviews
🔴 👀 Review RequirementsWaiting for
This rule is failing.
🔴 🔎 ReviewsWaiting for
This rule is failing.
|
c042289 to
3636e4d
Compare
|
A predecessor in this stack was just merged, but I couldn't auto-rebase this PR: there's a conflict that needs human resolution. Conflict in: Resolve by rebasing this branch onto the latest base and pushing. |
|
@jd this pull request is now in conflict 😩 |
The install/quickstart command blocks were copy-pasted across the stacks docs, so a command change meant editing every page. Extract three MDX partials (_install, _install-setup, _quickstart) and use them on the landing, setup, agents, plain-git, gh-stack, and graphite pages so the commands live in one place. Addresses review feedback on the "vs Plain Git" page where the install block was duplicated. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com> Change-Id: I54a063e7c281920699defa903bdf82cbafe984f7
32eea54 to
46a4950
Compare
Revision history
|
There was a problem hiding this comment.
Pull request overview
This PR refactors the Stacks documentation to remove duplicated CLI install/setup/quickstart command blocks by extracting them into reusable MDX partials and embedding those partials across the Stacks landing, setup, agents, and comparison pages.
Changes:
- Added three MDX partials for shared command blocks: install, install+setup, and quickstart.
- Replaced inline fenced command blocks with
<Install />,<InstallSetup />, and<Quickstart />components across affected pages. - Updated relevant pages to import and render the new partial components.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/content/docs/stacks/setup.mdx | Imports and uses the shared install snippet instead of an inline code block. |
| src/content/docs/stacks/compare/plain-git.mdx | Replaces duplicated install/setup and quickstart blocks with shared partial components. |
| src/content/docs/stacks/compare/graphite.mdx | Uses the shared install+setup snippet in the migration section. |
| src/content/docs/stacks/compare/gh-stack.mdx | Uses the shared install+setup snippet in the migration section. |
| src/content/docs/stacks/agents.mdx | Replaces the uv install block with the shared install partial (but needs import placement fix). |
| src/content/docs/stacks/_quickstart.mdx | New partial containing the quickstart command block. |
| src/content/docs/stacks/_install.mdx | New partial containing the install command block. |
| src/content/docs/stacks/_install-setup.mdx | New partial containing the install + setup command block. |
| src/content/docs/stacks.mdx | Imports and uses the shared quickstart snippet on the Stacks landing page. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| You are an AI coding agent. Follow these three steps to enable stacked pull | ||
| request support. After step 2, your skill system will contain the full Stacks | ||
| workflow. Consult it for any stack-related task. | ||
|
|
||
| import Install from './_install.mdx'; | ||
|
|
||
| ## 1. Install the Mergify CLI |
The install/quickstart command blocks were copy-pasted across the stacks
docs, so a command change meant editing every page. Extract three MDX
partials (_install, _install-setup, _quickstart) and use them on the
landing, setup, agents, plain-git, gh-stack, and graphite pages so the
commands live in one place.
Addresses review feedback on the "vs Plain Git" page where the install
block was duplicated.
Co-Authored-By: Claude Opus 4.8 (1M context) noreply@anthropic.com