docs: add fix-a-failed-install guide (guides checkpoint 6)#41
Merged
Conversation
Fifth catalog entry: ordered triage from which/doctor through PATH, stale-version, native-platform-package, and source-build repairs, each step linking into the install-debugging reference it summarizes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
There was a problem hiding this comment.
Pull request overview
Adds a new Guides entry to help users recover from a broken Coven CLI installation, and updates the guides index/metadata plus the guides-validation script to pin key commands and cross-links.
Changes:
- Added a new “Fix a failed install” guide with a stepwise triage flow and links into the install-debugging reference.
- Registered the new guide in the Guides nav (
meta.json) and linked it from the Guides catalog. - Updated
check-guides-docsto require the new page, key command mentions, and the install-debugging cross-link.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| scripts/check-guides-docs.mjs | Pins the new guide slug, required command mentions, and verifies the install-debugging cross-link. |
| content/docs/guides/meta.json | Registers fix-a-failed-install in the Guides section pages list. |
| content/docs/guides/index.mdx | Adds the new guide link to the Guides catalog table. |
| content/docs/guides/fix-a-failed-install.mdx | New recovery/triage guide for diagnosing and repairing failed CLI installs. |
Steps 1-2 assumed a POSIX shell while the guide covers win32-x64; add Get-Command and PATH-split PowerShell blocks. Also replace npm bin -g (removed in npm 9) with npm prefix -g. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Checkpoint 6 of the guides-section goal, stacked on #40: the Fix a Failed Install guide — a 6-step ordered triage that either repairs the install or routes to the exact reference section.
Changes
content/docs/guides/fix-a-failed-install.mdx— triage order:which -a covendiagnosis → PATH repair per install method → stale version/npx cache cleanup → native platform package rules → source-build fallback → final verification; troubleshooting footercontent/docs/guides/index.mdx— catalog row linkedcontent/docs/guides/meta.json— page registeredscripts/check-guides-docs.mjs— pins for triage commands and the install-debugging cross-linkSources
Distilled from
content/docs/cli/install-debugging.mdx(fast-triage table, PATH/version/platform/source sections) andreference/troubleshooting.mdx; platform targets (darwin-arm64,linux-x64,win32-x64) and wrapper/native-package split match the published npm packaging in../coven/npm.Validation
check-guides-docs,english-only,no-leading-h1,mermaid-parse,validate-links(0 errors) ✅npx fumadocs-mdx+npx tsc --noEmit+npx next build✅ — all five guide pages prerendered