Skip to content

Commit b1484ef

Browse files
authored
Merge pull request #5 from opensourceops/codex/v0.3.0-docs
Publish agentctl 0.3.0 workflow API v1 documentation
2 parents 160adb0 + 7443df2 commit b1484ef

75 files changed

Lines changed: 170 additions & 128 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/pages.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ concurrency:
1515
cancel-in-progress: true
1616

1717
env:
18-
AGENTCTL_COMMIT: "736379ed5f49b0dbe1ad79ac4e4ba794e2c73c47"
18+
AGENTCTL_COMMIT: "2aeaa88fba71162206b5f08f5bda4f0150247e4f"
1919
NODE_VERSION: "24.4.1"
2020
PNPM_VERSION: "11.9.0"
2121
RUST_TOOLCHAIN: "1.88.0"

astro.config.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ export default defineConfig({
5656
{
5757
label: 'Start here',
5858
items: [
59-
{ slug: 'overview', label: 'Overview', badge: 'v1alpha1' },
59+
{ slug: 'overview', label: 'Overview', badge: 'v1' },
6060
{ slug: 'why-agentctl', label: 'Why agentctl' },
6161
{ slug: 'concepts/product', label: 'Product definition' },
6262
{ slug: 'concepts/framework-completeness', label: 'Framework completeness' },

docs/execution/AGENTCTL_DOCS_DECISIONS.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,12 @@ A checked manifest maps canonical source files to public routes. The importer fa
2828

2929
Status: accepted, 2026-07-23.
3030

31-
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.
31+
Public pages distinguish deterministic tests, mock-protocol tests, retained
32+
live OpenAI evidence, locally executed container evidence, hosted CI execution,
33+
syntax validation, deferred work, and unsupported work. The site identifies
34+
`agentctl.dev/v1` as the stable workflow document API while keeping the 0.3 CLI
35+
and crates explicitly pre-1.0 and avoiding unsupported production or provider
36+
claims.
3237

3338
## D006: Static and restrained design
3439

docs/execution/AGENTCTL_DOCS_INFORMATION_ARCHITECTURE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
- Architecture
1717
- Contributing
1818
- GitHub
19-
- `v1alpha1` maturity indicator
19+
- workflow API `v1` indicator
2020

2121
## Learning paths
2222

public/meta/agentctl-source.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
{
22
"product": "agentctl",
3-
"version": "0.2.0",
4-
"workflowApi": "agentctl.dev/v1alpha1",
5-
"commit": "736379ed5f49b0dbe1ad79ac4e4ba794e2c73c47",
3+
"version": "0.3.0",
4+
"workflowApi": "agentctl.dev/v1",
5+
"commit": "2aeaa88fba71162206b5f08f5bda4f0150247e4f",
66
"dirty": false,
77
"sourceRepository": "https://github.com/opensourceops/agentctl",
88
"importedFiles": 61

scripts/content-manifest.mjs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ export const contentManifest = [
66
['docs/TOOLS.md', '_generated/concepts/tools.md', 'Tools and effects', 'Tool contracts, effect classes, idempotency, and deterministic checks.'],
77
['docs/memory.md', '_generated/concepts/memory.md', 'State and memory', 'Separate runtime state, working memory, long-term memory, and prompt cache.'],
88
['docs/PACKS.md', '_generated/concepts/packs.md', 'Reusable packs', 'Use versioned local content with integrity verification.'],
9-
['docs/guides/INSTALLATION.md', '_generated/getting-started/installation.md', 'Installation', 'Build or install the current v1alpha1 candidate from reviewed source.'],
9+
['docs/guides/INSTALLATION.md', '_generated/getting-started/installation.md', 'Installation', 'Build or install agentctl 0.3 with workflow API v1 from reviewed source.'],
1010
['docs/guides/GETTING_STARTED.md', '_generated/getting-started/index.md', 'Getting started', 'Run and inspect a credential-free deterministic workflow.'],
1111
['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.'],
1212
['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 = [
4242
['docs/execution/COMPLETENESS_VERIFICATION.md', '_generated/reference/completeness-verification.md', 'Completeness verification', 'Deterministic, container, security, and independent review evidence.'],
4343
['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.'],
4444
['docs/COMPATIBILITY.md', '_generated/reference/compatibility.md', 'Compatibility', 'Preserved, migrated, changed, removed, and explicit non-goal contracts.'],
45-
['docs/MIGRATING_FROM_TYPESCRIPT.md', '_generated/reference/migration.md', 'Migrate from TypeScript', 'Translate supported legacy workflows to strict v1alpha1 YAML.'],
45+
['docs/MIGRATING_FROM_TYPESCRIPT.md', '_generated/reference/migration.md', 'Migrate from TypeScript', 'Translate supported legacy workflows to strict workflow API v1 YAML.'],
4646
['docs/ARCHITECTURE.md', '_generated/architecture/index.md', 'Architecture overview', 'Crate boundaries, execution, determinism, concurrency, and packaging.'],
4747
['docs/architecture/DIAGRAMS.md', '_generated/architecture/diagrams.md', 'Architecture diagrams', 'Fourteen verified diagrams for compilation, state, effects, recovery, deployment, and crates.'],
4848
['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 = [
5959
['docs/development/ADD_MIGRATION.md', '_generated/contributing/add-migration.md', 'Add a store migration', 'Version and test forward SQLite migrations.'],
6060
['docs/development/DOCUMENTATION.md', '_generated/contributing/documentation.md', 'Write documentation', 'Own content in the right repository and verify it end to end.'],
6161
['docs/TESTING.md', '_generated/contributing/testing.md', 'Testing strategy', 'Credential-free gates, acceptance layers, fuzzing, and live evidence.'],
62-
['docs/RELEASE_PROCESS.md', '_generated/contributing/release.md', 'Release process', 'Prepare and verify a v1alpha1 release candidate without overstating evidence.']
62+
['docs/RELEASE_PROCESS.md', '_generated/contributing/release.md', 'Release process', 'Prepare and verify an exact-commit release without overstating evidence.']
6363
];

scripts/sync-agentctl.mjs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -221,7 +221,7 @@ await copyFile(
221221
const metadata = {
222222
product: 'agentctl',
223223
version,
224-
workflowApi: 'agentctl.dev/v1alpha1',
224+
workflowApi: 'agentctl.dev/v1',
225225
commit,
226226
dirty,
227227
sourceRepository: 'https://github.com/opensourceops/agentctl',

src/components/Header.astro

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const base = import.meta.env.BASE_URL;
1414
<div class="site-header">
1515
<div class="title-wrapper sl-flex">
1616
<SiteTitle />
17-
<span class="maturity" aria-label="Workflow API maturity: version 1 alpha 1">v1alpha1</span>
17+
<span class="maturity" aria-label="Workflow API version 1">v1</span>
1818
</div>
1919
<nav class="top-links" aria-label="Primary">
2020
<a href={`${base}overview/`}>Docs</a>

src/components/Homepage.astro

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -166,15 +166,15 @@ const shortCommit = source.commit.slice(0, 8);
166166
<p class="eyebrow">Current maturity</p>
167167
<h2 id="maturity-title">Exact-commit evidence across local and hosted gates</h2>
168168
<p>
169-
The workflow API is <code>agentctl.dev/v1alpha1</code>. Deterministic composition, durable recovery,
169+
The workflow API is <code>agentctl.dev/v1</code>. Deterministic composition, durable recovery,
170170
local persistence, native Linux arm64 containers, and bounded GPT-5.6 journeys have executable evidence.
171-
The pinned candidate also passed hosted Linux x64, macOS arm64, Windows x64, container, security,
171+
The pinned 0.3 release source also passed hosted Linux x64, macOS arm64, Windows x64, container, security,
172172
package, SBOM, and release-preparation gates. Other native providers and protocols have mock coverage
173173
at documented levels.
174174
</p>
175175
</div>
176176
<ul>
177-
<li>No stable v1 compatibility promise</li>
177+
<li>Stable workflow API v1; CLI and crates remain pre-1.0</li>
178178
<li>No exactly-once or in-process sandbox claim</li>
179179
<li>No distributed or cross-run scheduler claim</li>
180180
<li>No claim of live validation across every provider</li>

src/content/docs/_generated/architecture/decisions/0001.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,4 +8,4 @@ Status: accepted, 2026-07-22.
88
The graph, policy, state machine, persistence decisions, and recorded replay remain model-independent. Provider, tool, filesystem, process, MCP, A2A, internal-state mutation, clock, and ID behavior cross injected interfaces and receive durable effect identity when externally observable.
99

1010
This keeps models replaceable and tests credential-free. It requires more records and conservative uncertain states, but avoids hidden calls during replay. Dynamic model-owned orchestration is rejected.
11-
> Canonical source: [`docs/adr/0001-deterministic-core-explicit-effects.md`](https://github.com/opensourceops/agentctl/blob/main/docs/adr/0001-deterministic-core-explicit-effects.md). Verified against agentctl commit `736379ed5f49b0dbe1ad79ac4e4ba794e2c73c47`.
11+
> Canonical source: [`docs/adr/0001-deterministic-core-explicit-effects.md`](https://github.com/opensourceops/agentctl/blob/main/docs/adr/0001-deterministic-core-explicit-effects.md). Verified against agentctl commit `2aeaa88fba71162206b5f08f5bda4f0150247e4f`.

0 commit comments

Comments
 (0)