Skip to content

Fix quickstart docs: broken links, missing prereqs, troubleshooting#877

Closed
nthmost-orkes wants to merge 1 commit intomainfrom
fix/quickstart-docs
Closed

Fix quickstart docs: broken links, missing prereqs, troubleshooting#877
nthmost-orkes wants to merge 1 commit intomainfrom
fix/quickstart-docs

Conversation

@nthmost-orkes
Copy link
Contributor

Summary

  • Fix broken quickstart links in README.md — the two links to conductor-oss.org/quickstart were returning 404. Updated to docs.conductor-oss.org/quickstart/.
  • Add missing prerequisites — Java 21+ was not listed (README.md and docs/quickstart/index.md). Also added Node.js v16+ to README.md.
  • Add troubleshooting callout in docs/quickstart/index.md for common issues new users hit: Java not found, port 8080 already in use, and a pointer to the Docker alternative.

Motivation

New users following the quickstart were hitting dead links and missing prerequisite info, with no guidance when things went wrong. These are small changes that should reduce friction for first-time setup.

Test plan

…d 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)
@v1r3n
Copy link
Collaborator

v1r3n commented Mar 17, 2026

Addressed this in a separate PR. Closing.

@v1r3n v1r3n closed this Mar 17, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants