Skip to content

docs(install): consolidate compat sections into one Compatibility section#57

Merged
colinhacks merged 1 commit into
mainfrom
install-compat-section
Jun 21, 2026
Merged

docs(install): consolidate compat sections into one Compatibility section#57
colinhacks merged 1 commit into
mainfrom
install-compat-section

Conversation

@colinhacks

Copy link
Copy Markdown
Contributor

Merges the three install-page compatibility sections — "In an existing project", "Compat mode", and "Package manager inference" — into a single ## Compatibility section, and replaces the prose walls (especially near the top of the page) with dense, scannable content.

What changed

  • One ## Compatibility section subsumes the three former sections.
  • Detection precedence is a names-only list (packageManagerdevEngines.packageManager → lockfile on disk), not a numbered prose block.
  • Per-incumbent lockfile/round-trip table — rows npm / pnpm / Yarn / bun / Nub; columns lockfile, round-trip (npm/pnpm/bun read+write, Yarn read-only), full-page link.
  • The existing config-chip table (<PmSupport>) moves under a ### Config it reads subsection, unchanged.
  • ### Nub identity condensed to a 4-bullet surface list plus the brand-boundary paragraph; the two existing callouts (contradictions / inference-vs-pin) retained verbatim.
  • ### Compat mode — a brief note on --node / NODE_COMPAT linking to the runtime overview.
  • Page intro tightened; the now-dead #package-manager-inference anchor repointed to #compatibility.

Net −22 lines; no information dropped, just densified. Every cell grounded in wiki/research/nub-incumbent-behavior.md + the code; Yarn read-only per the project's settled compat claim.

Verification

  • MDX body compiles cleanly via @mdx-js/mdx + remark-gfm (the fumadocs table stack).
  • Structural check: single ## Compatibility heading, balanced code fences (34), 4 matched <Callout> pairs, 1 <PmSupport>, valid GFM table syntax.
  • All per-PM links (/docs/install/{npm,pnpm,yarn,bun}, /docs/pm, /docs/runtime#--node) resolve to existing pages/anchors.

https://claude.ai/code/session_01YRvztkcr4fzfg9rD5edUwa

…tion

Merge 'In an existing project', 'Compat mode', and 'Package manager
inference' into a single Compatibility section. Replace the prose blocks
with a detection-precedence list, a per-incumbent lockfile/round-trip
table, the existing config-chip table, a condensed Nub identity
subsection, the contradiction/pin callouts, and a brief compat-mode note.
Tighten the page intro and fix the now-dead #package-manager-inference
anchor to #compatibility.

Claude-Session: https://claude.ai/code/session_01YRvztkcr4fzfg9rD5edUwa
Copilot AI review requested due to automatic review settings June 21, 2026 18:12
@vercel

vercel Bot commented Jun 21, 2026

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
nub Ready Ready Preview, Comment Jun 21, 2026 6:14pm

Request Review

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

@colinhacks colinhacks merged commit af55e7d into main Jun 21, 2026
18 checks passed
@colinhacks

Copy link
Copy Markdown
Contributor Author

Shipped in v0.1.10: https://github.com/nubjs/nub/releases/tag/v0.1.10

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants