7 Commits

Author SHA1 Message Date
Naomi Most 20a643e906 docs: fix jq pipeline in quickstart — use .output, drop tail -1 (conductor-oss/getting-started#11, #12) (#988)
Two bugs in the quickstart jq examples:
1. `.outputParameters` doesn't exist in WorkflowRun; correct field is `.output`
2. `| tail -1 |` was a workaround for "Auto-detected server:" printing to stdout,
   but that message goes to stderr. With multi-line --sync JSON, tail -1 strips
   the closing `}` and breaks jq parsing.

Remove the workaround, fix the field name, and correct the note.
2026-04-28 00:00:40 -07:00
Naomi Most 62d9e6de97 fix: replace broken jq pipeline with plain async start for WORKFLOW_ID capture (conductor-oss/getting-started#12) (#1003) 2026-04-10 01:57:32 -07:00
Naomi Most fcca1b99cf docs: fix busy-wait loop in quickstart Python worker example (#981)
Replace `while True: pass` with `threading.Event().wait()` to avoid
pegging a CPU core at 100%. Fixes conductor-oss/getting-started#13.

Co-authored-by: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>
2026-04-07 13:52:41 -07:00
Naomi Most 5d5f6a55f6 fix: onboarding quickstart accuracy improvements (#930)
* Fix quickstart documentation: broken links, missing prerequisites, and troubleshooting

- Fix two broken quickstart links in README.md (conductor-oss.org/quickstart -> docs.conductor-oss.org/quickstart/)
- Add Node.js v16+ and Java 21+ to prerequisites in README.md
- Add Java 21+ prerequisite to docs/quickstart/index.md
- Add troubleshooting callout box for common issues (Java not found, port conflicts, Docker alternative)

- #2: Add prominent Java 21 prerequisite callout before Phase 1 / Start Conductor
- #5: Fix JS SDK package name from @conductor-oss/conductor-client to conductor-javascript-sdk; add npm install command
- #13: Replace busy-wait `while True: pass` with `time.sleep(0.1)` + import time (CPU yield between poll cycles)
- #14: Update Docker cURL --sync equivalent to use correct synchronous endpoint /api/workflow/{name}/run

* MAESTRO: fix quickstart output format and jq pipeline (issues #11, #12)

- #11: Replace clean JSON output block with realistic CLI output showing
  the "Auto-detected server:" prefix line and wall-of-JSON format; add
  jq pipeline example for readable extraction
- #12: Fix Phase 3 WORKFLOW_ID capture to use `2>/dev/null | tail -1`
  before piping to jq, with comment explaining stdout/stderr separation

* MAESTRO: fix README quickstart warnings (issues #3, #4)

- Add 600 MB download notice after 'conductor server start' (#3)
- Add idempotency note after 'conductor workflow create' (#4)
- Note: README Slack badge uses join.slack.com format; CONTRIBUTING.md
  uses orkes-conductor.slack.com format — same invite token, tracked as #32

* MAESTRO: fix bug report template to be language-neutral (issue #31)

* docs: remove Adoptium-specific links per reviewer feedback

Replace distribution-specific Java install links with generic "Install
Java 21" language — different organizations use different JDK
distributions and Adoptium is not an official distro.

Co-Authored-By: Claude Sonnet 4.6 (1M context) <noreply@anthropic.com>

* fix: correct curl equivalent for workflow start --sync

Use the actual sync endpoint POST /api/workflow/execute/{name}/{version}
instead of the non-existent /api/workflow/{name}/run path.

Reported in PR review feedback from Miguel Prieto.

* docs: add CLAUDE.md and doc verification rules to AGENTS.md

Adds a hard rule: all REST endpoints, CLI commands, and code examples
in docs must be verified against source before committing. Triggered by
a hallucinated /run endpoint in the quickstart curl example (PR #930).

CLAUDE.md: new repo-level guidance for Claude Code with verification
checklist and key source locations.
AGENTS.md: new Documentation Verification section with the same rules
in a form readable by any AI coding agent.

* docs: reframe doc rules as proactive workflow, not prohibitions

Replace 'never do X' rules with step-by-step workflows for each content
type: REST endpoints, CLI commands, SDK examples, expected output blocks.
Core principle: open the source first, derive the doc from what you read.

Applies to both AGENTS.md (any AI agent) and CLAUDE.md (Claude Code).

---------
2026-04-06 16:20:08 -07:00
Naomi Most 21238445a9 fix: use correct JS SDK package in quickstart worker example (#5) (#975) 2026-04-04 14:19:56 -07:00
Viren Baraiya adb29cfbdb Jdbc workers (#878)
* JDBC workers
* Documentation update
2026-03-18 17:05:24 -07:00
Viren Baraiya cf21f0238f Overhaul documentation site with modern design (#863)
* Overhaul documentation site with modern design and new content

- Redesign homepage with hero section, scrolling logo wall, value strip, feature cards, architecture section, FAQ, and CTA
- Add new architecture pages: Durable Execution, Agents & AI, JSON + Code Native
- Add Quickstart guide with polyglot worker examples (Java, Python, JS, Go, C#, Ruby, Rust)
- Modern CSS theme: Instrument Serif + DM Sans + IBM Plex Mono, solarized code blocks, dark mode support
- Replace curl examples with Conductor CLI commands across all pages
- Add SEO meta descriptions to 30+ pages targeting durable code execution, workflow engine, saga pattern keywords
- Restructure mkdocs.yml navigation with tabs, search, and content features
- Add MkDocs Material theme overrides and serve-docs.sh helper script
2026-03-16 08:47:47 -07:00