Commit Graph

124 Commits

Author SHA1 Message Date
Viren Baraiya 58b461bf34 Agent docs (#1406) 2026-08-20 12:52:15 -07:00
Andrew Lai (AJ) 96a613f8c3 Update README and publish.ymls to use ui-next instead of the former ui (#1168) 2026-06-15 10:56:39 -07:00
Najeeb Thangal KP c804f6e220 fix:update slack invite links across README.md and CONTRIBUTING.md (#1160) 2026-06-09 10:21:35 -07:00
Viren Baraiya f9defcd698 Update project title in README (#1070) 2026-05-04 22:39:16 -07:00
Viren Baraiya 7affe4f30b Improve README, ROADMAP, and docs
CI / build (push) Has been cancelled
CI / test-harness (push) Has been cancelled
CI / build-ui (push) Has been cancelled
2026-04-12 12:41:26 -07:00
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
Nicholas Cole d31654a285 Fix the link to Getting Started in the README.md (#945) 2026-04-01 06:58:40 -07:00
Viren Baraiya 35e0d7ffa9 Update README.md 2026-03-23 11:46:34 -07:00
Viren Baraiya ad6f0ea7db update README 2026-03-23 09:22:15 -07:00
Rajeshwar Agrawal 9e99cac928 Feature: Add support for ES8 Persistence (#739) 2026-03-18 10:34:53 -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
Viren Baraiya 08cb977208 feat: Add GENERATE_PDF system task for markdown-to-PDF conversion (#818)
CI / build (push) Has been cancelled
CI / build-ui (push) Has been cancelled
* feat: Add GENERATE_PDF system task for markdown-to-PDF conversion
2026-03-09 15:31:48 -07:00
Viren Baraiya b0c20af2c0 fix spacing 2026-02-02 15:36:17 -08: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
Viren Baraiya 43c7120138 simplify build 2026-01-19 00:32:46 -08:00
Viren Baraiya 31f317a156 update to the build 2026-01-18 23:38:45 -08:00
Karl Goeltner 422bbd143e Fix readme after supporting both ES & OS modules 2025-10-25 09:05:38 -07:00
Karl Goeltner 745fe9367a Support both ES & OS via gradle build flag 2025-10-23 17:12:14 -07:00
nthmost-orkes f7776e2aca adding optional/suggested pre-commit hook to run spotlessApply 2025-10-08 00:57:41 -07:00
Tran Ngoc Nhan f401a6fcae Update README TOC 2025-08-02 21:18:16 +07:00
Viren Baraiya 72932e2ae0 Update README.md 2025-07-01 00:45:36 -07:00
Jeff Bull 8b710391ef README updates + new bug_report template 2025-06-27 14:06:31 -07:00
Karl Goeltner 74ed34a187 Remove lucene entirely, simply comment out ES or OS import for usage 2025-06-17 09:16:44 -07:00
Karl Goeltner a1f38ec6b0 Add default lucene support for ES, commented out OS 2025-06-16 19:27:02 -07:00
Gulam Mohiuddeen 2cc59ee9b8 Enhance logo visibility by supporting light and dark modes in README.md
This PR updates the README file to ensure the project logo is visible in both light and dark mode themes on platforms like GitHub.

Changes Made:
Added a <picture> element to conditionally display the logo based on the user's prefers-color-scheme setting.
Light mode: Displays the dark logo version (default).
Dark mode: Displays the light logo version (optimized for dark backgrounds).
Why this change?
Previously, the logo was not visible when viewed in dark mode, potentially affecting readability and branding consistency. This update ensures a seamless viewing experience for all users, regardless of their preferred theme.
2024-12-16 17:17:04 +05:30
Viren Baraiya 003fda3cb0 Update README.md 2024-11-24 20:15:03 -08:00
Jeff Bull 094c402493 Update README.md 11-19-24 2024-11-19 14:31:57 -08:00
Viren Baraiya e5021ae738 update docker configs to resolve conflicts with airplay server 2024-11-15 11:10:33 -08:00
Jeff Bull 67370fb5af Updated READEME.md with a new format, additional community, resource, and support links as buttons, and included a clearer outline of steps in the Getting Started section to assist with docker deployments. 2024-11-12 18:16:17 -08:00
Viren Baraiya e1f495a6c9 Update README.md 2024-08-23 14:53:45 -07:00
Viren Baraiya 6aac51ea92 Update README.md 2024-08-23 14:49:34 -07:00
Viren Baraiya 896e49efd1 Update README.md 2024-08-23 14:44:08 -07:00
Viren Baraiya 237a479769 update README 2024-07-03 00:20:36 -07:00
Viren Baraiya 098a72006a add link to the roadmap 2024-05-12 11:41:56 -07:00
Viren Baraiya e669ab9eff Update README.md 2024-04-27 19:39:41 -07:00
Viren Baraiya 55268f0633 Update README.md
CI / build (push) Has been cancelled
CI / build-ui (push) Has been cancelled
2024-04-10 10:23:48 -07:00
Riza Farheen 416f1391a4 Update README.md (#113) 2024-04-02 23:01:56 -07:00
Viren Baraiya 1fc19167e1 Update README.md 2024-03-27 10:52:09 -07:00
Ikko Eltociear Ashimine e04c9bf129 Update README.md (#72)
againt -> against
2024-02-15 22:26:25 +04:00
Viren Baraiya 386dde5106 Update README.md 2024-02-11 19:12:35 -08:00
Riza Farheen 5cc377f6c2 Documentation link update in Readme (#54)
* Update README.md

* Revert "Update README.md"

This reverts commit fe16da94b68dff80313a262c6db49f4a78425fe9.

* Update README.md
2024-01-30 14:57:32 -08:00
Viren Baraiya 582a74c0c1 Update README.md 2024-01-23 12:02:19 -08:00
Viren Baraiya 3faeec6a03 Update README.md 2024-01-04 14:51:52 -08:00
Viren Baraiya 00c0673a21 Merge pull request #21 from conductor-oss/oss_prep
Prepare for the build and release
2023-12-21 14:11:36 -08:00
Dilip Lukose 65cb6ea393 Update README.md with correct logo path 2023-12-21 00:01:57 -08:00
Dilip Lukose 25de43153e Update README.md
Updated logo file
2023-12-20 23:40:42 -08:00
Viren Baraiya 71b2b5731d license header changes 2023-12-20 11:20:22 -08:00
Viren Baraiya 3c15237fdf Update README.md 2023-12-13 12:36:50 -08:00
Viren Baraiya c68ca4e58f Update README.md 2023-12-13 11:36:58 -08:00