Back to Details

build-artifacts

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Build Artifacts

生成构件

Generate SKILL.md and TOC.md for an existing documentation package.
为现有文档包生成SKILL.md和TOC.md文件。

Usage

使用方法

/build-artifacts prisma@latest         # Generate artifacts
/build-artifacts prisma@latest --force  # Regenerate even if exists
/build-artifacts prisma@latest         # 生成构件
/build-artifacts prisma@latest --force  # 即使已存在也重新生成

Input

输入参数

$ARGUMENTS
format: 
{config_name}@{version}
(e.g., 
prisma@latest
, 
nextjs@16.1.3
)
Optional flags:
  • --force
    - Regenerate even if artifacts already exist
$ARGUMENTS
格式: 
{config_name}@{version}
(例如: 
prisma@latest
, 
nextjs@16.1.3
)
可选参数:
  • --force
    - 即使构件已存在也重新生成

Prerequisites

前置条件

The 
contents/
directory and 
olore-lock.json
must already exist at 
vault/packages/{config_name}/{version}/
. Run 
/download-docs
first if they don't.
bash
test -d vault/packages/{config_name}/{version}/contents && echo "OK" || echo "NOT_FOUND"
If 
contents/
not found:
error: {config_name}@{version} contents/ not found - run /download-docs first
contents/
目录和
olore-lock.json
必须已存在于
vault/packages/{config_name}/{version}/
路径下。如果不存在，请先运行
/download-docs
命令。
bash
test -d vault/packages/{config_name}/{version}/contents && echo "OK" || echo "NOT_FOUND"
如果未找到
contents/
目录:
error: {config_name}@{version} contents/ not found - run /download-docs first

Execution Steps

执行步骤

Step 1: Parse Arguments and Load Metadata

步骤1: 解析参数并加载元数据

Parse 
$ARGUMENTS
:
  • Extract 
    config_name
    and 
    version
    from 
    {config_name}@{version}
  • Check for 
    --force
    flag
Read metadata:
bash
cat vault/packages/{config_name}/{version}/olore-lock.json
cat vault/configs/{config_name}.json
解析
$ARGUMENTS
:
  • 从
    {config_name}@{version}
    中提取
    config_name
    和
    version
  • 检查是否存在
    --force
    参数
读取元数据:
bash
cat vault/packages/{config_name}/{version}/olore-lock.json
cat vault/configs/{config_name}.json

Step 2: Check if Already Built

步骤2: 检查是否已生成构件

bash
test -f vault/packages/{config_name}/{version}/SKILL.md && test -f vault/packages/{config_name}/{version}/TOC.md && echo "EXISTS" || echo "NOT_FOUND"
If both exist and no 
--force
flag:
skip: {config_name}@{version} artifacts already built (use --force to rebuild)
Return early.
bash
test -f vault/packages/{config_name}/{version}/SKILL.md && test -f vault/packages/{config_name}/{version}/TOC.md && echo "EXISTS" || echo "NOT_FOUND"
如果两个文件都已存在且未使用
--force
参数:
skip: {config_name}@{version} artifacts already built (use --force to rebuild)
提前返回。

Step 3: Determine Tier

步骤3: 确定层级

bash
file_count=$(find vault/packages/{config_name}/{version}/contents -type f \( -name "*.md" -o -name "*.mdx" \) | wc -l)
total_size=$(du -sk vault/packages/{config_name}/{version}/contents | cut -f1)
TierCriteria
1< 30 files AND < 500KB
230-100 files OR 500KB-2MB
3> 100 files OR > 2MB
bash
file_count=$(find vault/packages/{config_name}/{version}/contents -type f \( -name "*.md" -o -name "*.mdx" \) | wc -l)
total_size=$(du -sk vault/packages/{config_name}/{version}/contents | cut -f1)
层级判定条件
1< 30个文件 AND < 500KB
230-100个文件 OR 500KB-2MB
3> 100个文件 OR > 2MB

Step 4: Generate TOC.md

步骤4: 生成TOC.md

Read the appropriate template based on tier:
bash
undefined
根据层级读取对应的模板:
bash
undefined

Tier 1

层级1

cat vault/packages/docs-packager/1.0.0/templates/toc-tier1.md
cat vault/packages/docs-packager/1.0.0/templates/toc-tier1.md

Tier 2

层级2

cat vault/packages/docs-packager/1.0.0/templates/toc-tier2.md
cat vault/packages/docs-packager/1.0.0/templates/toc-tier2.md

Tier 3

层级3

cat vault/packages/docs-packager/1.0.0/templates/toc-tier3.md

Create `vault/packages/{config_name}/{version}/TOC.md` following the template structure.
cat vault/packages/docs-packager/1.0.0/templates/toc-tier3.md

按照模板结构创建`vault/packages/{config_name}/{version}/TOC.md`文件。

Step 5: Generate SKILL.md

步骤5: 生成SKILL.md

IMPORTANT: The 
name
field MUST be 
olore-{config_name}-{version}
to match the installed folder name.
Read the appropriate template based on tier:
bash
undefined
重要提示: 
name
字段必须设置为
olore-{config_name}-{version}
，以匹配已安装的文件夹名称。
根据层级读取对应的模板:
bash
undefined

Tier 1

层级1

cat vault/packages/docs-packager/1.0.0/templates/skill-tier1.md
cat vault/packages/docs-packager/1.0.0/templates/skill-tier1.md

Tier 2

层级2

cat vault/packages/docs-packager/1.0.0/templates/skill-tier2.md
cat vault/packages/docs-packager/1.0.0/templates/skill-tier2.md

Tier 3

层级3

cat vault/packages/docs-packager/1.0.0/templates/skill-tier3.md

Create `vault/packages/{config_name}/{version}/SKILL.md` following the template structure.
cat vault/packages/docs-packager/1.0.0/templates/skill-tier3.md

按照模板结构创建`vault/packages/{config_name}/{version}/SKILL.md`文件。

Step 6: Return Summary

步骤6: 返回摘要

Return ONLY a brief summary:
done: {config_name}@{version} artifacts built (SKILL.md + TOC.md), tier {tier}
仅返回简短摘要:
done: {config_name}@{version} artifacts built (SKILL.md + TOC.md), tier {tier}

Outputs

输出文件

  • vault/packages/{config_name}/{version}/SKILL.md
    - Skill definition
  • vault/packages/{config_name}/{version}/TOC.md
    - Table of contents
  • vault/packages/{config_name}/{version}/SKILL.md
    - Skill定义文件
  • vault/packages/{config_name}/{version}/TOC.md
    - 目录文件