Skip to content

docs(readme): improve install section structure and clarity - #1

Open
redbasecap wants to merge 2 commits into
norandom:mainfrom
redbasecap:docs/improve-install-section
Open

docs(readme): improve install section structure and clarity#1
redbasecap wants to merge 2 commits into
norandom:mainfrom
redbasecap:docs/improve-install-section

Conversation

@redbasecap

Copy link
Copy Markdown

Summary

Improves the README Install section for readability without changing any required user-facing behavior:

  • Adds a Prerequisites block (opencode; Node 22+ / pnpm for the dev path).
  • Splits install into Release install (recommended) and Development install with fenced code blocks.
  • Adds an explicit Restart opencode step and an Install notes block covering release vs dev behavior.

All wording asserted by tests/docs-asset.test.ts is preserved (e.g. the exact 1. Install the latest release with \curl ...`line and thelatest release` substring).

Verification

Full check suite green:

  • pnpm run build (tsc --noEmit): PASS
  • pnpm run eslint (with CI=true, matching the Dagger lint pipeline): PASS
  • pnpm run test: 124/124 pass
  • pnpm run validate:assets: OpenUltraCode assets are valid

Note

Pushed from a fork (redbasecap/OpenUltraCode) because the authenticated account has READ-only access to norandom/OpenUltraCode.

🤖 Generated with OpenUltraCode

redbasecap and others added 2 commits August 26, 2026 18:28
Restructure the Install section with prerequisites, separate release and development paths, fenced code blocks, and a restart/verification note. Preserve all required user-facing behavior asserted by tests/docs-asset.test.ts.
- Drop the redundant inline curl command and lone numbered step; keep the code block
- Name install-dev.sh explicitly instead of a dangling "This also"
- Restore "confirm you restarted" as the first troubleshooting step before re-running the installer

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01YMFa3tAeGzainohPXsLwph
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