From 7443df245f41f1347c9be6ea1379721bebda3f89 Mon Sep 17 00:00:00 2001 From: Ompragash Date: Tue, 28 Jul 2026 11:12:33 +0530 Subject: [PATCH] document agentctl 0.3.0 workflow API v1 --- .github/workflows/pages.yml | 2 +- astro.config.mjs | 2 +- docs/execution/AGENTCTL_DOCS_DECISIONS.md | 7 ++++++- .../AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md | 2 +- public/meta/agentctl-source.json | 6 +++--- scripts/content-manifest.mjs | 6 +++--- scripts/sync-agentctl.mjs | 2 +- src/components/Header.astro | 2 +- src/components/Homepage.astro | 6 +++--- .../_generated/architecture/decisions/0001.md | 2 +- .../_generated/architecture/decisions/0002.md | 2 +- .../_generated/architecture/decisions/0003.md | 2 +- .../_generated/architecture/decisions/0004.md | 2 +- .../_generated/architecture/decisions/0005.md | 2 +- .../_generated/architecture/decisions/0006.md | 2 +- .../_generated/architecture/decisions/0007.md | 2 +- .../docs/_generated/architecture/diagrams.md | 5 +++-- .../docs/_generated/architecture/index.md | 2 +- .../concepts/framework-completeness.md | 2 +- src/content/docs/_generated/concepts/memory.md | 2 +- src/content/docs/_generated/concepts/packs.md | 2 +- .../docs/_generated/concepts/policies.md | 2 +- .../docs/_generated/concepts/product.md | 17 +++++++++++++---- src/content/docs/_generated/concepts/tools.md | 2 +- .../docs/_generated/concepts/workflow-model.md | 8 +++++--- .../docs/_generated/contributing/add-action.md | 2 +- .../_generated/contributing/add-migration.md | 2 +- .../_generated/contributing/add-provider.md | 2 +- .../_generated/contributing/developer-guide.md | 2 +- .../_generated/contributing/documentation.md | 2 +- .../docs/_generated/contributing/index.md | 2 +- .../docs/_generated/contributing/release.md | 13 +++++++------ .../docs/_generated/contributing/testing.md | 2 +- .../docs/_generated/durable-execution/index.md | 2 +- .../docs/_generated/examples/approval-gated.md | 4 ++-- .../_generated/examples/ci-quality-gate.md | 4 ++-- .../examples/provider-portability.md | 6 +++--- .../_generated/examples/recorded-replay.md | 4 ++-- .../_generated/examples/release-readiness.md | 4 ++-- .../_generated/examples/repository-audit.md | 4 ++-- .../_generated/examples/scheduled-review.md | 4 ++-- .../_generated/getting-started/first-agent.md | 2 +- .../docs/_generated/getting-started/index.md | 2 +- .../_generated/getting-started/installation.md | 9 +++++---- src/content/docs/_generated/guides/ci-cd.md | 4 ++-- .../docs/_generated/guides/container.md | 18 +++++++++--------- .../docs/_generated/guides/local-operation.md | 2 +- .../docs/_generated/guides/selective-repair.md | 2 +- .../_generated/guides/workflow-authoring.md | 4 ++-- .../docs/_generated/observability/index.md | 2 +- .../docs/_generated/operations/scheduled.md | 2 +- src/content/docs/_generated/providers/a2a.md | 2 +- src/content/docs/_generated/providers/index.md | 2 +- src/content/docs/_generated/providers/mcp.md | 2 +- .../docs/_generated/reference/capabilities.md | 2 +- src/content/docs/_generated/reference/cli.md | 6 +++--- .../docs/_generated/reference/compatibility.md | 17 ++++++++++++----- .../reference/completeness-verification.md | 2 +- .../docs/_generated/reference/database.md | 2 +- .../docs/_generated/reference/environment.md | 2 +- .../reference/limitation-burndown.md | 2 +- .../docs/_generated/reference/limitations.md | 9 ++++++--- .../reference/live-framework-verification.md | 2 +- .../docs/_generated/reference/migration.md | 4 ++-- .../docs/_generated/reference/output.md | 2 +- .../docs/_generated/reference/terminology.md | 2 +- src/content/docs/_generated/reference/yaml.md | 4 ++-- src/content/docs/_generated/security/index.md | 2 +- .../docs/_generated/security/threat-model.md | 2 +- .../docs/_generated/troubleshooting/index.md | 5 +++-- src/content/docs/overview.md | 14 +++++++++++--- src/content/docs/why-agentctl.md | 6 +++++- src/data/agentctl-source.json | 6 +++--- src/data/home-workflow.yaml | 2 +- tests/site.spec.ts | 2 +- 75 files changed, 170 insertions(+), 128 deletions(-) diff --git a/.github/workflows/pages.yml b/.github/workflows/pages.yml index 607d2c0..43b012b 100644 --- a/.github/workflows/pages.yml +++ b/.github/workflows/pages.yml @@ -15,7 +15,7 @@ concurrency: cancel-in-progress: true env: - AGENTCTL_COMMIT: "736379ed5f49b0dbe1ad79ac4e4ba794e2c73c47" + AGENTCTL_COMMIT: "2aeaa88fba71162206b5f08f5bda4f0150247e4f" NODE_VERSION: "24.4.1" PNPM_VERSION: "11.9.0" RUST_TOOLCHAIN: "1.88.0" diff --git a/astro.config.mjs b/astro.config.mjs index 1717fbe..3f7303d 100644 --- a/astro.config.mjs +++ b/astro.config.mjs @@ -56,7 +56,7 @@ export default defineConfig({ { label: 'Start here', items: [ - { slug: 'overview', label: 'Overview', badge: 'v1alpha1' }, + { slug: 'overview', label: 'Overview', badge: 'v1' }, { slug: 'why-agentctl', label: 'Why agentctl' }, { slug: 'concepts/product', label: 'Product definition' }, { slug: 'concepts/framework-completeness', label: 'Framework completeness' }, diff --git a/docs/execution/AGENTCTL_DOCS_DECISIONS.md b/docs/execution/AGENTCTL_DOCS_DECISIONS.md index 758269c..338500f 100644 --- a/docs/execution/AGENTCTL_DOCS_DECISIONS.md +++ b/docs/execution/AGENTCTL_DOCS_DECISIONS.md @@ -28,7 +28,12 @@ A checked manifest maps canonical source files to public routes. The importer fa Status: accepted, 2026-07-23. -Public pages distinguish deterministic tests, mock-protocol tests, retained live OpenAI evidence, locally executed container evidence, hosted CI configuration, hosted CI execution, syntax validation, deferred work, and unsupported work. The site calls the project a `v1alpha1` release candidate preparation, not stable or production proven. +Public pages distinguish deterministic tests, mock-protocol tests, retained +live OpenAI evidence, locally executed container evidence, hosted CI execution, +syntax validation, deferred work, and unsupported work. The site identifies +`agentctl.dev/v1` as the stable workflow document API while keeping the 0.3 CLI +and crates explicitly pre-1.0 and avoiding unsupported production or provider +claims. ## D006: Static and restrained design diff --git a/docs/execution/AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md b/docs/execution/AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md index b878462..39baa84 100644 --- a/docs/execution/AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md +++ b/docs/execution/AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md @@ -16,7 +16,7 @@ - Architecture - Contributing - GitHub -- `v1alpha1` maturity indicator +- workflow API `v1` indicator ## Learning paths diff --git a/public/meta/agentctl-source.json b/public/meta/agentctl-source.json index eb3f9d8..95c4d07 100644 --- a/public/meta/agentctl-source.json +++ b/public/meta/agentctl-source.json @@ -1,8 +1,8 @@ { "product": "agentctl", - "version": "0.2.0", - "workflowApi": "agentctl.dev/v1alpha1", - "commit": "736379ed5f49b0dbe1ad79ac4e4ba794e2c73c47", + "version": "0.3.0", + "workflowApi": "agentctl.dev/v1", + "commit": "2aeaa88fba71162206b5f08f5bda4f0150247e4f", "dirty": false, "sourceRepository": "https://github.com/opensourceops/agentctl", "importedFiles": 61 diff --git a/scripts/content-manifest.mjs b/scripts/content-manifest.mjs index 703cf6b..28c54ae 100644 --- a/scripts/content-manifest.mjs +++ b/scripts/content-manifest.mjs @@ -6,7 +6,7 @@ export const contentManifest = [ ['docs/TOOLS.md', '_generated/concepts/tools.md', 'Tools and effects', 'Tool contracts, effect classes, idempotency, and deterministic checks.'], ['docs/memory.md', '_generated/concepts/memory.md', 'State and memory', 'Separate runtime state, working memory, long-term memory, and prompt cache.'], ['docs/PACKS.md', '_generated/concepts/packs.md', 'Reusable packs', 'Use versioned local content with integrity verification.'], - ['docs/guides/INSTALLATION.md', '_generated/getting-started/installation.md', 'Installation', 'Build or install the current v1alpha1 candidate from reviewed source.'], + ['docs/guides/INSTALLATION.md', '_generated/getting-started/installation.md', 'Installation', 'Build or install agentctl 0.3 with workflow API v1 from reviewed source.'], ['docs/guides/GETTING_STARTED.md', '_generated/getting-started/index.md', 'Getting started', 'Run and inspect a credential-free deterministic workflow.'], ['docs/guides/FIRST_AGENT_WORKFLOW.md', '_generated/getting-started/first-agent.md', 'First agent workflow', 'Run a bounded tool-using agent without a paid API key.'], ['docs/guides/WORKFLOW_AUTHORING.md', '_generated/guides/workflow-authoring.md', 'Author workflows', 'Learn workflow YAML in execution order.'], @@ -42,7 +42,7 @@ export const contentManifest = [ ['docs/execution/COMPLETENESS_VERIFICATION.md', '_generated/reference/completeness-verification.md', 'Completeness verification', 'Deterministic, container, security, and independent review evidence.'], ['docs/execution/LIVE_FRAMEWORK_VERIFICATION.md', '_generated/reference/live-framework-verification.md', 'Live framework verification', 'Sanitized GPT-5.6 scenario, recovery, replay, usage, and container evidence.'], ['docs/COMPATIBILITY.md', '_generated/reference/compatibility.md', 'Compatibility', 'Preserved, migrated, changed, removed, and explicit non-goal contracts.'], - ['docs/MIGRATING_FROM_TYPESCRIPT.md', '_generated/reference/migration.md', 'Migrate from TypeScript', 'Translate supported legacy workflows to strict v1alpha1 YAML.'], + ['docs/MIGRATING_FROM_TYPESCRIPT.md', '_generated/reference/migration.md', 'Migrate from TypeScript', 'Translate supported legacy workflows to strict workflow API v1 YAML.'], ['docs/ARCHITECTURE.md', '_generated/architecture/index.md', 'Architecture overview', 'Crate boundaries, execution, determinism, concurrency, and packaging.'], ['docs/architecture/DIAGRAMS.md', '_generated/architecture/diagrams.md', 'Architecture diagrams', 'Fourteen verified diagrams for compilation, state, effects, recovery, deployment, and crates.'], ['docs/adr/0001-deterministic-core-explicit-effects.md', '_generated/architecture/decisions/0001.md', 'ADR 0001: Deterministic core', 'Keep graph, policy, state, and replay model-independent.'], @@ -59,5 +59,5 @@ export const contentManifest = [ ['docs/development/ADD_MIGRATION.md', '_generated/contributing/add-migration.md', 'Add a store migration', 'Version and test forward SQLite migrations.'], ['docs/development/DOCUMENTATION.md', '_generated/contributing/documentation.md', 'Write documentation', 'Own content in the right repository and verify it end to end.'], ['docs/TESTING.md', '_generated/contributing/testing.md', 'Testing strategy', 'Credential-free gates, acceptance layers, fuzzing, and live evidence.'], - ['docs/RELEASE_PROCESS.md', '_generated/contributing/release.md', 'Release process', 'Prepare and verify a v1alpha1 release candidate without overstating evidence.'] + ['docs/RELEASE_PROCESS.md', '_generated/contributing/release.md', 'Release process', 'Prepare and verify an exact-commit release without overstating evidence.'] ]; diff --git a/scripts/sync-agentctl.mjs b/scripts/sync-agentctl.mjs index c16b620..e2f86ca 100644 --- a/scripts/sync-agentctl.mjs +++ b/scripts/sync-agentctl.mjs @@ -221,7 +221,7 @@ await copyFile( const metadata = { product: 'agentctl', version, - workflowApi: 'agentctl.dev/v1alpha1', + workflowApi: 'agentctl.dev/v1', commit, dirty, sourceRepository: 'https://github.com/opensourceops/agentctl', diff --git a/src/components/Header.astro b/src/components/Header.astro index abbd5f9..548d6c7 100644 --- a/src/components/Header.astro +++ b/src/components/Header.astro @@ -14,7 +14,7 @@ const base = import.meta.env.BASE_URL;