Commit Graph

4 Commits

Author SHA1 Message Date
Naomi Most 9937f07bb4 Remove Adoptium links; never specify Java download source in docs (#986) 2026-04-12 10:22:28 -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 8b2cef9069 build: add dependency pinning system (#964) (#965)
Converts tribal knowledge about version constraints into grep-able,
enforceable documentation.

- Add // PINNED (#964): tag to all 8 hard-cap locations
- Standardize // Security: and // Compat: prefixes on version floors
- Introduce revGraalVM variable; all five GraalVM artifacts now use it
- Add dependabot.yml ignore rules for protobuf* >= 4.0
- Add dependabot.yml graalvm group for coordinated family upgrades
- Add ## Dependency Pinning section to AGENTS.md documenting all conventions
2026-04-03 16:58:14 -07:00
Viren Baraiya 8998f10b3f Docker build fixes and deployments (#747)
Publish the docker image and add scripts for starting up local server
2026-02-02 15:25:21 -08:00