Skip to content

Rewrite README as a newcomer how-to - #53

Merged
hieuphung97 merged 1 commit into
mainfrom
docs/readme-newcomer-onboarding
Sep 8, 2026
Merged

hieuphung97 merged 1 commit into
mainfrom
docs/readme-newcomer-onboarding

Conversation

@hieuphung97

Copy link
Copy Markdown
Owner

Summary

  • Rewrite README.md so a newcomer sees the YouTube demo, a table of contents, Orca setup via official docs, dely:setup, then per-harness install — not a protocol essay.
  • Keep the existing install/Quickstart contract needles (Cursor, Copilot, Kiro, orca orchestration run-list --json).
  • Add focused greps in tests/contracts.sh for demo placement, Contents links, official Orca URLs, and the how-to constraints on Project setup / How Dely works.

Test plan

  • bash tests/contracts.sh (also run by CI contracts)
  • Open the README on GitHub: demo thumbnail is above Contents, links jump, YouTube opens https://www.youtube.com/watch?v=6pRWkhlQSAc
  • Skim Quickstart → Project setup → your harness under Install without hitting protocol/loader lectures

Made with Cursor

… not protocol.

Co-authored-by: Cursor <cursoragent@cursor.com>
@hieuphung97
hieuphung97 marked this pull request as ready for review September 8, 2026 13:49
@hieuphung97
hieuphung97 merged commit 13e6037 into main Sep 8, 2026
1 check passed
@hieuphung97
hieuphung97 deleted the docs/readme-newcomer-onboarding branch September 8, 2026 13:50
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.

1 participant