docs: separate plugin install from full manual install (#1544)

This commit is contained in:
Affaan Mustafa
2026-04-21 18:28:52 -04:00
committed by GitHub
parent 8ae1499122
commit 8c422a76f4
4 changed files with 82 additions and 59 deletions

View File

@@ -25,6 +25,7 @@ const publicInstallDocs = [
'README.md',
'README.zh-CN.md',
'docs/pt-BR/README.md',
'docs/zh-CN/README.md',
'docs/ja-JP/skills/configure-ecc/SKILL.md',
'docs/zh-CN/skills/configure-ecc/SKILL.md',
];
@@ -43,6 +44,32 @@ for (const relativePath of publicInstallDocs) {
});
}
const pluginAndManualInstallDocs = [
'README.md',
'README.zh-CN.md',
'docs/zh-CN/README.md',
];
for (const relativePath of pluginAndManualInstallDocs) {
const content = fs.readFileSync(path.join(repoRoot, relativePath), 'utf8');
test(`${relativePath} warns not to run the full installer after plugin install`, () => {
assert.ok(
content.includes('--profile full'),
'Expected docs to mention the full installer explicitly'
);
assert.ok(
content.includes('/plugin install'),
'Expected docs to mention plugin install explicitly'
);
assert.ok(
content.includes('不要再运行')
|| content.includes('do not run'),
'Expected docs to warn that plugin install and full install are not sequential'
);
});
}
if (failed > 0) {
console.log(`\nFailed: ${failed}`);
process.exit(1);