fix: repair README onboarding guidance

[yohamta0]

Summary

• correct the typed-parameter example so workflow steps live under steps: and reference declared parameters
• link installation, MCP, deployment, actions, operations, artifacts, distributed execution, and embedding references to their canonical documentation
• keep the README quickstart aligned with the current docs structure

Why

The parameter example accidentally placed a runnable step inside params:, producing misleading YAML for new users. Several onboarding references were also plain text, which added friction when readers tried to continue into the documentation.

Impact

New users can copy a structurally valid parameter example and reach the relevant setup and reference pages directly from the README.

Validation

• validated the corrected parameter example with dagu validate
• verified every README documentation URL resolves successfully
• ran git diff --check

---

Summary by cubic

Fix README onboarding by correcting the parameter YAML example and adding canonical docs links. New users can copy a valid example and reach the right setup pages quickly.

• Bug Fixes
  • Move the runnable step out of params: into steps: and reference declared params via ${params.*}.
  • Add canonical links across onboarding sections (Installation, MCP, deployment models, tools/actions, examples, artifacts, distributed execution, embedded API, Web UI).
  • Align quickstart wording with the current docs structure.

^{Written for commit abec5af. Summary will update on new commits.}

Summary by CodeRabbit

• Documentation
  • Updated documentation links to point to specific guides and reference pages.
  • Expanded workflow examples to show passing scope and dry-run options to extraction steps.
  • Added details about package layouts and official and third-party actions.

[Copilot]

Copilot was unable to review this pull request because the user who requested the review has reached their quota limit.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 74132b22-c64f-489c-8f80-0486c1a416f1

📥 Commits

Reviewing files that changed from the base of the PR and between 01c2336 and abec5af.

📒 Files selected for processing (1)

• README.md

---

📝 Walkthrough

Walkthrough

README documentation links now target specific guides and pages. The parameterized workflow example passes customer_id, change_scope, and dry_run to extract while retaining retry settings. Action documentation now includes more specific package-layout and execution details.

Changes

README documentation refresh

Layer / File(s)	Summary
Direct documentation links README.md	Generic references now link directly to installation, MCP, deployment, examples, security, artifacts, distributed execution, and embedded API guides.
Workflow parameters and action documentation README.md	The workflow example passes parameters directly to extract. Action references now link to official and third-party action guides and describe manifest, entrypoint, sub-DAG, and workspace behavior.

Estimated code review effort: 2 (Simple) | ~10 minutes

🚥 Pre-merge checks | ✅ 5

✅ Passed checks (5 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly and concisely describes the README onboarding fixes.
Description check	✅ Passed	The description explains the changes, rationale, impact, and validation, but it does not include all template headings or checklist items.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Commit unit tests in branch agent/fix-onboarding-docs

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}