From 83bcda60ff63617dd1d0d5d46a4a317ad570569c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E6=98=9F=E6=9C=88?= Date: Thu, 4 Jun 2026 22:46:11 +0800 Subject: [PATCH] refactor(prompt): rename subcommands and add frontmatter output MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit - Rename: user→usage-reference, author→workflow-authoring, adapter→adapter-developing - Remove: developer (content lives in CLAUDE.md) - All prompts output complete SKILL.md with YAML frontmatter - Setup instructions simplified: uwf prompt bootstrap > SKILL.md - Remove all bun references, use pnpm/npm - Fix CLAUDE.md: fixed→independent versioning - Delete old reference files (user/author/developer/adapter) Closes #66 --- CLAUDE.md | 2 +- packages/cli/src/__tests__/prompt.test.ts | 95 +++++++----- packages/cli/src/cli.ts | 32 ++-- packages/cli/src/commands/prompt.ts | 66 +++------ ...nce.ts => adapter-developing-reference.ts} | 13 +- packages/util/src/bootstrap-reference.ts | 5 +- packages/util/src/developer-reference.ts | 140 ------------------ packages/util/src/index.ts | 8 +- .../{user-reference.ts => usage-reference.ts} | 22 ++- packages/util/src/version.ts | 2 + ...nce.ts => workflow-authoring-reference.ts} | 13 +- 11 files changed, 141 insertions(+), 257 deletions(-) rename packages/util/src/{adapter-reference.ts => adapter-developing-reference.ts} (94%) delete mode 100644 packages/util/src/developer-reference.ts rename packages/util/src/{user-reference.ts => usage-reference.ts} (88%) create mode 100644 packages/util/src/version.ts rename packages/util/src/{author-reference.ts => workflow-authoring-reference.ts} (94%) diff --git a/CLAUDE.md b/CLAUDE.md index de5de11..ef1c888 100644 --- a/CLAUDE.md +++ b/CLAUDE.md @@ -266,7 +266,7 @@ node scripts/publish-all.mjs --dry-run # preview without publishing - `workspace:^` dependencies resolve to `^x.y.z` on publish - Publish order defined in `scripts/publish-all.mjs` (dependency order) -- Changesets config: `.changeset/config.json` (fixed mode, public access) +- Changesets config: `.changeset/config.json` (independent versioning, public access) ### End-to-end: Author → Register → Run diff --git a/packages/cli/src/__tests__/prompt.test.ts b/packages/cli/src/__tests__/prompt.test.ts index 7618721..63b42ee 100644 --- a/packages/cli/src/__tests__/prompt.test.ts +++ b/packages/cli/src/__tests__/prompt.test.ts @@ -6,86 +6,109 @@ import { describe, expect, test } from "vitest"; const __dirname = dirname(fileURLToPath(import.meta.url)); import { - cmdPromptAdapter, - cmdPromptAuthor, - cmdPromptDeveloper, + cmdPromptAdapterDeveloping, + cmdPromptBootstrap, cmdPromptList, cmdPromptSetup, cmdPromptUsage, - cmdPromptUser, + cmdPromptUsageReference, + cmdPromptWorkflowAuthoring, } from "../commands/prompt.js"; describe("prompt commands", () => { - test("prompt list returns all prompt names", () => { + test("prompt list returns new prompt names", () => { const result = cmdPromptList(); expect(result).toBeInstanceOf(Array); - expect(result).toContain("user"); - expect(result).toContain("author"); - expect(result).toContain("developer"); - expect(result).toContain("adapter"); + expect(result).toContain("usage"); + expect(result).toContain("workflow-authoring"); + expect(result).toContain("adapter-developing"); + expect(result).toContain("bootstrap"); + expect(result).not.toContain("user"); + expect(result).not.toContain("author"); + expect(result).not.toContain("developer"); + expect(result).not.toContain("adapter"); for (const name of result) { expect(name).toMatch(/^\S+$/); } }); - test("prompt user returns non-empty markdown string", () => { - const result = cmdPromptUser(); + test("prompt usage-reference returns non-empty markdown string with frontmatter", () => { + const result = cmdPromptUsageReference(); expect(typeof result).toBe("string"); expect(result).toContain("uwf"); expect(result).toContain("thread"); expect(result).toContain("workflow"); expect(result).toContain("Quick Start"); + expect(result).toContain("---"); + expect(result).toContain("name:"); + expect(result).toContain("version:"); expect(result.length).toBeGreaterThan(500); }); - test("prompt author returns non-empty markdown string", () => { - const result = cmdPromptAuthor(); + test("prompt workflow-authoring returns non-empty markdown string with frontmatter", () => { + const result = cmdPromptWorkflowAuthoring(); expect(typeof result).toBe("string"); expect(result).toContain("frontmatter"); expect(result).toContain("graph"); expect(result).toContain("$START"); expect(result).toContain("$END"); expect(result).toContain("$status"); + expect(result).toContain("---"); + expect(result).toContain("name:"); + expect(result).toContain("version:"); expect(result.length).toBeGreaterThan(500); }); - test("prompt developer returns non-empty markdown string", () => { - const result = cmdPromptDeveloper(); - expect(typeof result).toBe("string"); - expect(result).toContain("Monorepo"); - expect(result).toContain("CAS"); - expect(result).toContain("Biome"); - expect(result.length).toBeGreaterThan(500); - }); - - test("prompt adapter returns non-empty markdown string", () => { - const result = cmdPromptAdapter(); + test("prompt adapter-developing returns non-empty markdown string with frontmatter", () => { + const result = cmdPromptAdapterDeveloping(); expect(typeof result).toBe("string"); expect(result).toContain("createAgent"); expect(result).toContain("AgentContext"); expect(result).toContain("frontmatter"); + expect(result).toContain("---"); + expect(result).toContain("name:"); + expect(result).toContain("version:"); expect(result.length).toBeGreaterThan(500); }); - test("prompt usage combines all references", () => { + test("prompt bootstrap returns non-empty skill with frontmatter", () => { + const result = cmdPromptBootstrap(); + expect(typeof result).toBe("string"); + expect(result).toContain("uwf"); + expect(result).toContain("---"); + expect(result.length).toBeGreaterThan(100); + }); + + test("prompt usage combines remaining references (no developer)", () => { const result = cmdPromptUsage(); expect(typeof result).toBe("string"); - expect(result).toContain("User Reference"); - expect(result).toContain("Author Reference"); - expect(result).toContain("Developer Reference"); - expect(result).toContain("Adapter Reference"); + expect(result).toContain("Usage Reference"); + expect(result).toContain("Workflow Authoring Reference"); + expect(result).toContain("Adapter Developing Reference"); + expect(result).not.toContain("Developer Reference"); expect(result).toContain("---"); expect(result.length).toBeGreaterThan(2000); }); - test("prompt setup returns setup instructions", () => { + test("prompt setup returns simplified setup instructions", () => { const result = cmdPromptSetup(); expect(typeof result).toBe("string"); expect(result).toContain("uwf Skill Setup"); - expect(result).toContain("uwf prompt usage"); - expect(result).toContain("uwf prompt setup"); + expect(result).toContain("uwf prompt bootstrap"); expect(result).toContain("SKILL.md"); expect(result).toContain("version"); + expect(result).not.toMatch(/\bbun (install|run|test|changeset|version|release)\b/); + }); + + test("prompt setup references new subcommand names", () => { + const result = cmdPromptSetup(); + expect(result).toContain("uwf prompt usage"); + expect(result).toContain("uwf prompt workflow-authoring"); + expect(result).toContain("uwf prompt adapter-developing"); + expect(result).not.toContain("uwf prompt user"); + expect(result).not.toContain("uwf prompt author"); + expect(result).not.toContain("uwf prompt developer"); + expect(result).not.toMatch(/uwf prompt adapter\b(?!-developing)/); }); test("prompt help subcommand is suppressed", { timeout: 30_000 }, () => { @@ -97,10 +120,10 @@ describe("prompt commands", () => { expect(output).not.toMatch(/help\s+\[command\]/i); expect(output).toContain("usage"); expect(output).toContain("setup"); - expect(output).toContain("user"); - expect(output).toContain("author"); - expect(output).toContain("developer"); - expect(output).toContain("adapter"); + expect(output).toContain("workflow-authoring"); + expect(output).toContain("adapter-developing"); + expect(output).toContain("bootstrap"); expect(output).toContain("list"); + expect(output).not.toContain("developer"); }); }); diff --git a/packages/cli/src/cli.ts b/packages/cli/src/cli.ts index 0fdb272..64f2d42 100755 --- a/packages/cli/src/cli.ts +++ b/packages/cli/src/cli.ts @@ -5,14 +5,13 @@ import { Command } from "commander"; import { cmdConfigGet, cmdConfigList, cmdConfigSet } from "./commands/config.js"; import { cmdLogClean, cmdLogList, cmdLogShow } from "./commands/log.js"; import { - cmdPromptAdapter, - cmdPromptAuthor, + cmdPromptAdapterDeveloping, cmdPromptBootstrap, - cmdPromptDeveloper, cmdPromptList, cmdPromptSetup, cmdPromptUsage, - cmdPromptUser, + cmdPromptUsageReference, + cmdPromptWorkflowAuthoring, } from "./commands/prompt.js"; import { cmdSetup, cmdSetupInteractive } from "./commands/setup.js"; import { cmdStepFork, cmdStepList, cmdStepRead, cmdStepShow } from "./commands/step.js"; @@ -523,31 +522,24 @@ prompt }); prompt - .command("adapter") - .description("Print the adapter reference (building agent adapters)") + .command("usage-reference") + .description("Print the usage reference (CLI guide + typical workflows)") .action(() => { - console.log(cmdPromptAdapter()); + console.log(cmdPromptUsageReference()); }); prompt - .command("author") - .description("Print the author reference (workflow YAML design guide)") + .command("workflow-authoring") + .description("Print the workflow authoring reference (YAML design guide)") .action(() => { - console.log(cmdPromptAuthor()); + console.log(cmdPromptWorkflowAuthoring()); }); prompt - .command("developer") - .description("Print the developer reference (coding conventions + architecture)") + .command("adapter-developing") + .description("Print the adapter developing reference (building agent adapters)") .action(() => { - console.log(cmdPromptDeveloper()); - }); - -prompt - .command("user") - .description("Print the user reference (CLI guide + typical workflows)") - .action(() => { - console.log(cmdPromptUser()); + console.log(cmdPromptAdapterDeveloping()); }); prompt diff --git a/packages/cli/src/commands/prompt.ts b/packages/cli/src/commands/prompt.ts index 1a42173..70fbe2d 100644 --- a/packages/cli/src/commands/prompt.ts +++ b/packages/cli/src/commands/prompt.ts @@ -1,24 +1,21 @@ import { - generateAdapterReference, - generateAuthorReference, + generateAdapterDevelopingReference, generateBootstrapReference, - generateDeveloperReference, - generateUserReference, + generateUsageReference, + generateWorkflowAuthoringReference, } from "@united-workforce/util"; export { - generateAdapterReference as cmdPromptAdapter, - generateAuthorReference as cmdPromptAuthor, + generateAdapterDevelopingReference as cmdPromptAdapterDeveloping, generateBootstrapReference as cmdPromptBootstrap, - generateDeveloperReference as cmdPromptDeveloper, - generateUserReference as cmdPromptUser, + generateUsageReference as cmdPromptUsageReference, + generateWorkflowAuthoringReference as cmdPromptWorkflowAuthoring, }; const PROMPT_ENTRIES: ReadonlyArray<{ name: string; generate: () => string }> = [ - { name: "user", generate: generateUserReference }, - { name: "author", generate: generateAuthorReference }, - { name: "developer", generate: generateDeveloperReference }, - { name: "adapter", generate: generateAdapterReference }, + { name: "usage", generate: generateUsageReference }, + { name: "workflow-authoring", generate: generateWorkflowAuthoringReference }, + { name: "adapter-developing", generate: generateAdapterDevelopingReference }, { name: "bootstrap", generate: generateBootstrapReference }, ]; @@ -27,7 +24,9 @@ export function cmdPromptList(): ReadonlyArray { } export function cmdPromptUsage(): string { - return PROMPT_ENTRIES.map((e) => e.generate()).join("\n\n---\n\n"); + return PROMPT_ENTRIES.filter((e) => e.name !== "bootstrap") + .map((e) => e.generate()) + .join("\n\n---\n\n"); } export function cmdPromptSetup(): string { @@ -42,7 +41,7 @@ so that you know how to use the \`uwf\` CLI for workflow orchestration. \`\`\`bash uwf --help \`\`\` - If not installed: \`bun add -g @united-workforce/cli\` + If not installed: \`npm install -g @united-workforce/cli\` 2. **Clean up old versions of the skill** (if any exist): - Look for any existing uwf/workflow skill files in your skill directories @@ -51,43 +50,24 @@ so that you know how to use the \`uwf\` CLI for workflow orchestration. - If the version matches the current CLI version (\`uwf --version\`), you're done — no update needed. - If the version is older, **delete the old skill file** before proceeding. -3. **Get the usage skill content:** +3. **Install the bootstrap skill:** \`\`\`bash - uwf prompt usage + uwf prompt bootstrap > ~/.hermes/skills/uwf/SKILL.md \`\`\` + The bootstrap prompt already includes complete YAML frontmatter — no editing needed. -4. **Create a SKILL.md file** in your skill directory (e.g. \`~/.hermes/skills/uwf/SKILL.md\`). - The output of \`uwf prompt usage\` is the skill body WITHOUT frontmatter. - You must prepend the following YAML frontmatter: - - \`\`\`yaml - --- - name: uwf - description: "Use when orchestrating multi-agent workflows with uwf (United Workforce). Covers CLI usage, workflow YAML authoring, moderator logic, and agent development." - version: - author: United Workforce - license: MIT - metadata: - hermes: - tags: [workflow, agents, orchestration, cli, yaml] - --- - \`\`\` - - Replace \`\` with the installed CLI version (from \`uwf --version\`). - -5. **Verify** the skill is loadable by your agent framework. +4. **Verify** the skill is loadable by your agent framework. ## Individual prompts -You can also get individual reference sections: +Each prompt outputs a complete SKILL.md with frontmatter — pipe directly to a file: \`\`\`bash -uwf prompt list # list available prompt names -uwf prompt user # user reference (CLI guide + typical workflows) -uwf prompt author # author reference (workflow YAML design guide) -uwf prompt developer # developer reference (coding conventions + architecture) -uwf prompt adapter # adapter reference (building agent adapters) -uwf prompt bootstrap # bootstrap skill YAML for Hermes agents +uwf prompt list # list available prompt names +uwf prompt usage > ~/.hermes/skills/uwf-usage/SKILL.md # CLI usage guide +uwf prompt workflow-authoring > ~/.hermes/skills/uwf-workflow-authoring/SKILL.md +uwf prompt adapter-developing > ~/.hermes/skills/uwf-adapter-developing/SKILL.md +uwf prompt bootstrap > ~/.hermes/skills/uwf/SKILL.md # bootstrap skill \`\`\` ## Notes diff --git a/packages/util/src/adapter-reference.ts b/packages/util/src/adapter-developing-reference.ts similarity index 94% rename from packages/util/src/adapter-reference.ts rename to packages/util/src/adapter-developing-reference.ts index f9582b2..2efc3fb 100644 --- a/packages/util/src/adapter-reference.ts +++ b/packages/util/src/adapter-developing-reference.ts @@ -1,5 +1,14 @@ -export function generateAdapterReference(): string { - return `# Adapter Reference +import { VERSION } from "./version.js"; + +export function generateAdapterDevelopingReference(): string { + return `--- +name: uwf-adapter-developing +description: "Guide for building a new agent adapter (CLI binary) for the workflow engine." +version: ${VERSION} +tags: [uwf, adapter, agent, development] +--- + +# Adapter Developing Reference Guide for building a new agent adapter (CLI binary) for the workflow engine. diff --git a/packages/util/src/bootstrap-reference.ts b/packages/util/src/bootstrap-reference.ts index 60b76e0..66d5121 100644 --- a/packages/util/src/bootstrap-reference.ts +++ b/packages/util/src/bootstrap-reference.ts @@ -18,8 +18,9 @@ YAML 状态机工作流引擎。当用户提到「workflow」「工作流」时 运行以下命令获取完整用法： \`\`\`bash -uwf skill user # 用户使用手册（CLI 命令、thread 生命周期） -uwf skill author # workflow 编写指南（role 定义、graph 路由、schema） +uwf prompt usage # 完整用法文档（所有引用合并） +uwf prompt workflow-authoring # workflow 编写指南（role 定义、graph 路由、schema） +uwf prompt adapter-developing # adapter 开发指南（构建新的 agent adapter） \`\`\` ## 快速参考 diff --git a/packages/util/src/developer-reference.ts b/packages/util/src/developer-reference.ts deleted file mode 100644 index bfdc597..0000000 --- a/packages/util/src/developer-reference.ts +++ /dev/null @@ -1,140 +0,0 @@ -export function generateDeveloperReference(): string { - return `# Developer Reference - -Guide for contributing to the workflow engine codebase. - -## Monorepo Structure - -\`\`\` -packages/ - protocol/ # Shared types (WorkflowPayload, StepNodePayload, etc.) - util/ # Base32, ULID, logger, frontmatter parsing, skill references - util-agent/ # createAgent factory, context builder, extract pipeline - agent-hermes/ # uwf-hermes CLI (spawns Hermes chat sessions) - agent-builtin/ # uwf-builtin CLI (direct LLM calls via OpenAI API) - cli/ # uwf CLI (moderator, thread/step/cas/config commands) -\`\`\` - -Dependency layers (each only imports from packages above it): -\`\`\` -protocol → util → util-agent → agent-hermes / agent-builtin / cli -\`\`\` - -External CAS: \`@ocas/core\` (store API, hashing, schema validation) + \`@ocas/fs\` (filesystem backend). - -## Coding Conventions - -### Functional-first - -| Rule | Description | -|------|-------------| -| \`type\` over \`interface\` | All type definitions use \`type\` | -| \`function\` over \`class\` | Pure functions + closures, no class | -| No \`this\` | Functions must not depend on \`this\` context | -| No inheritance | No \`extends\`, \`implements\`, \`abstract\` | -| No optional properties | Use \`T \\| null\` instead of \`?:\` | -| Immutability first | Use \`Readonly\`, \`as const\`, avoid mutation | - -Classes allowed only when required by third-party libraries or for Error subclasses. - -### Error Handling - -- \`Result\` type for expected failures (\`ok\`/\`err\` constructors from \`@united-workforce/util\`) -- \`throw\` only for unrecoverable bugs -- No try-catch for flow control - -### Async - -Always \`async/await\`, never \`.then()\` chains. - -### Logging - -\`console.*\` is banned (Biome \`noConsole\` rule). Use the structured logger: - -\`\`\`typescript -import { createLogger } from "@united-workforce/util"; -const log = createLogger(); -log("4KNMR2PX", "Loading workflow..."); // 8-char Crockford Base32 tag -\`\`\` - -Each call site gets a unique hand-written tag. \`grep "4KNMR2PX"\` in logs → instant code location. - -CLI package (\`@united-workforce/cli\`) may use \`console.log\` for user-facing output with a biome-ignore comment. - -### No Dynamic Import - -No \`await import()\` in production code. Always static top-level \`import\`. Test files are exempt. - -### Naming - -- Workflow names: verb-first kebab-case (\`solve-issue\`, \`review-code\`) -- IDs: Crockford Base32 — CAS hash (XXH64, 13-char), Thread ID (ULID, 26-char) - -## Development Workflow - -\`\`\`bash -bun install # install all workspace deps -bun run build # tsc --build (all packages) -bun run check # tsc + biome check + lint-log-tags -bun run format # biome format --write -bun test # run all tests -\`\`\` - -Before committing: \`bun run check\` + \`bun test\` must both pass. - -### Testing - -- \`cli\`: vitest -- Other packages: \`bun test\` -- Test files live in \`__tests__/\` directories - -### Publishing - -Fixed-mode versioning — all \`@united-workforce/*\` packages share the same version number. - -\`\`\`bash -bun changeset # describe the change -bun version # bump versions + changelogs -bun release # build + test + publish to npmjs -\`\`\` - -## Key Modules - -### Moderator (\`cli/src/moderator/\`) - -Status-based graph evaluator. Reads \`graph[lastRole][output.$status]\` to determine the next role. Zero LLM cost. - -### Extract Pipeline (\`util-agent/src/\`) - -1. Agent produces frontmatter markdown -2. \`parseFrontmatterMarkdown()\` extracts YAML frontmatter -3. \`tryFrontmatterFastPath()\` validates against role's output schema -4. If fast path fails, retries up to 2 times via agent continue -5. Validated output stored as CAS node - -### createAgent Factory (\`util-agent/src/run.ts\`) - -Shared entry point for all agent CLIs. Handles: -- Argument parsing (\`--thread\`, \`--role\`, \`--prompt\`) -- Context building (thread history, workflow definition) -- Output extraction and CAS persistence -- Frontmatter retry loop - -### CAS Integration - -All data is CAS-addressed via \`@ocas/core\`: -- \`store.put(schemaHash, data)\` → content hash -- \`store.get(hash)\` → node -- \`validate(store, node)\` → schema check -- Schemas registered at workflow add time - -## Commit Convention - -\`\`\` -(): - -type: feat | fix | refactor | docs | chore | test -scope: workflow | cli | moderator | util-agent | hermes | util | protocol -\`\`\` -`; -} diff --git a/packages/util/src/index.ts b/packages/util/src/index.ts index ab81113..3ac9725 100644 --- a/packages/util/src/index.ts +++ b/packages/util/src/index.ts @@ -1,11 +1,9 @@ export { generateActorReference } from "./actor-reference.js"; -export { generateAdapterReference } from "./adapter-reference.js"; +export { generateAdapterDevelopingReference } from "./adapter-developing-reference.js"; export { generateArchitectureReference } from "./architecture-reference.js"; -export { generateAuthorReference } from "./author-reference.js"; export { encodeUint64AsCrockford } from "./base32.js"; export { generateBootstrapReference } from "./bootstrap-reference.js"; export { generateCliReference } from "./cli-reference.js"; -export { generateDeveloperReference } from "./developer-reference.js"; export { env } from "./env.js"; export type { AgentFrontmatter, @@ -35,5 +33,7 @@ export { } from "./storage-root.js"; export type { LogFn, Result } from "./types.js"; export { extractUlidTimestamp, generateUlid } from "./ulid.js"; -export { generateUserReference } from "./user-reference.js"; +export { generateUsageReference } from "./usage-reference.js"; +export { VERSION } from "./version.js"; +export { generateWorkflowAuthoringReference } from "./workflow-authoring-reference.js"; export { generateYamlReference } from "./yaml-reference.js"; diff --git a/packages/util/src/user-reference.ts b/packages/util/src/usage-reference.ts similarity index 88% rename from packages/util/src/user-reference.ts rename to packages/util/src/usage-reference.ts index 4fa4577..c538927 100644 --- a/packages/util/src/user-reference.ts +++ b/packages/util/src/usage-reference.ts @@ -1,5 +1,14 @@ -export function generateUserReference(): string { - return `# User Reference +import { VERSION } from "./version.js"; + +export function generateUsageReference(): string { + return `--- +name: uwf-usage +description: "Guide for using the uwf CLI to manage workflows and threads." +version: ${VERSION} +tags: [uwf, workflow, cli, usage] +--- + +# Usage Reference Guide for using the uwf CLI to manage workflows and threads. @@ -123,14 +132,13 @@ uwf --format # output format (default: json) uwf -V, --version # print version \`\`\` -## Other Skill References +## Other Prompt References -For specific scenarios, run the corresponding \`uwf skill\` command: +For specific scenarios, run the corresponding \`uwf prompt\` command: | Scenario | Command | When to use | |----------|---------|-------------| -| Writing workflow YAML | \`uwf skill author\` | Designing roles, conditions, graphs, and edge prompts | -| Contributing to the engine | \`uwf skill developer\` | Modifying the workflow engine codebase itself | -| Building a new agent adapter | \`uwf skill adapter\` | Creating a new \`uwf-\` CLI adapter | +| Writing workflow YAML | \`uwf prompt workflow-authoring\` | Designing roles, conditions, graphs, and edge prompts | +| Building a new agent adapter | \`uwf prompt adapter-developing\` | Creating a new \`uwf-\` CLI adapter | `; } diff --git a/packages/util/src/version.ts b/packages/util/src/version.ts new file mode 100644 index 0000000..3e20583 --- /dev/null +++ b/packages/util/src/version.ts @@ -0,0 +1,2 @@ +// This version is kept in sync with package.json during releases. +export const VERSION = "0.1.0"; diff --git a/packages/util/src/author-reference.ts b/packages/util/src/workflow-authoring-reference.ts similarity index 94% rename from packages/util/src/author-reference.ts rename to packages/util/src/workflow-authoring-reference.ts index e63d081..3da3ffe 100644 --- a/packages/util/src/author-reference.ts +++ b/packages/util/src/workflow-authoring-reference.ts @@ -1,5 +1,14 @@ -export function generateAuthorReference(): string { - return `# Author Reference +import { VERSION } from "./version.js"; + +export function generateWorkflowAuthoringReference(): string { + return `--- +name: uwf-workflow-authoring +description: "Guide for designing and writing workflow YAML definitions." +version: ${VERSION} +tags: [uwf, workflow, yaml, authoring] +--- + +# Workflow Authoring Reference Guide for designing and writing workflow YAML definitions. -- 2.43.0