DocSmith Documentation Publishing

Usage

/doc-smith-publish
/doc-smith-publish --dir .aigne/doc-smith/dist
/doc-smith-publish --hub https://custom.hub.io

Options

--dir <path>

-d

--hub <url>

-h

https://docsmith.aigne.io

Workflow

Step 1: Check Dependencies

test -d {skill_path}/scripts/node_modules || (cd {skill_path}/scripts && npm install)

{skill_path}

skills/doc-smith-publish

Step 2: Detect Publishing Target

1. User specifies the

   --dir

   parameter → Use the specified directory
2. Not specified → Check if the

   .aigne/doc-smith/dist

   directory exists
3. Neither exists → Check if the current directory contains

   assets/nav.js

   (doc-smith output marker)
4. None found → Throw an error, prompting the user to run

   /doc-smith-create

   first to generate documentation

Step 3: Read Metadata

.aigne/doc-smith/config.yaml

• projectName

  → Publishing title (title)

• projectDesc

  → Publishing description (description)

Step 4: Execute Publishing

node {skill_path}/scripts/publish.mjs --config-stdin <<'EOF'
{
  "source": { "type": "dir", "path": "{dist_path}" },
  "hub": "{hub_url}",
  "workspace": ".aigne/doc-smith",
  "metadata": {
    "title": "{title}",
    "description": "{description}",
    "visibility": "public"
  }
}
EOF

• {skill_path}

  : Directory path of this Skill

• {dist_path}

  : Publishing directory determined in Step 2

• {hub_url}

  : DocSmith Hub URL (default

  https://docsmith.aigne.io

  , can be overridden by

  --hub

  )

• {title}

  : Title obtained in Step 3

• {description}

  : Description obtained in Step 3

Step 5: Display Results

Documentation published successfully! Preview URL: {vibeUrl}

appUrl

.aigne/doc-smith/config.yaml

Error Handling

/doc-smith-create

npm install

/doc-smith-publish

/doc-smith-publish