Polish docs from 5-agent review

- INSTALL.md: add prerequisites, Windows note, verify step, clone
  deletion in uninstall
- README.codex.md: fix Windows section (junctions not symlinks),
  add description field guidance, consistent terminology
- install-codex.mjs: accurate link type labels (symlink vs junction)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
This commit is contained in:
Drew Ritter
2026-02-05 16:34:05 -08:00
parent 3626ccc53e
commit bcccc69271
3 changed files with 35 additions and 16 deletions

View File

@@ -64,19 +64,21 @@ function createSymlink() {
}
}
// Create the symlink (or junction on Windows)
// Create the link (symlink on macOS/Linux, junction on Windows)
const linkType = isWindows ? 'junction' : 'dir';
const linkLabel = isWindows ? 'junction' : 'symlink';
try {
symlinkSync(repoSkillsDir, symlinkPath, 'junction');
console.log(`✓ Created symlink: ${symlinkPath}${repoSkillsDir}`);
symlinkSync(repoSkillsDir, symlinkPath, linkType);
console.log(`✓ Created ${linkLabel}: ${symlinkPath}${repoSkillsDir}`);
} catch (err) {
if (isWindows) {
// Symlink failed on Windows — try junction via mklink /J
// Node API failed on Windows — try junction via cmd.exe
try {
execSync(`cmd /c mklink /J "${symlinkPath}" "${repoSkillsDir}"`, { stdio: 'pipe' });
console.log(`✓ Created junction: ${symlinkPath}${repoSkillsDir}`);
} catch (junctionErr) {
console.error(`✗ Failed to create symlink or junction: ${junctionErr.message}`);
console.error(` On Windows, enable Developer Mode or run as administrator.`);
console.error(`✗ Failed to create junction: ${junctionErr.message}`);
console.error(` Try running PowerShell as administrator.`);
process.exit(1);
}
} else {