[Issue #1] README quickstart section #12

Merged

HugoNijhuis merged 2 commits from issue-1-readme-quickstart into main 2026-01-09 15:41:51 +00:00

Conversation 2 Commits 2 Files Changed 1 +112

HugoNijhuis commented 2026-01-09 15:36:25 +00:00

Owner

Copy Link

Summary

• Adds README.md with a complete quickstart guide
• Covers prerequisites (Go 1.23, WASM setup)
• Includes example app code with reactive counter
• Documents HTML host setup, build, and run commands
• Shows expected output in browser

Closes #1

Test plan

• Follow the quickstart steps on a fresh clone
• Verify the example code compiles with GOOS=js GOARCH=wasm go build
• Confirm the app runs and counter works in browser

🤖 Generated with Claude Code

## Summary - Adds README.md with a complete quickstart guide - Covers prerequisites (Go 1.23, WASM setup) - Includes example app code with reactive counter - Documents HTML host setup, build, and run commands - Shows expected output in browser Closes #1 ## Test plan - [ ] Follow the quickstart steps on a fresh clone - [ ] Verify the example code compiles with `GOOS=js GOARCH=wasm go build` - [ ] Confirm the app runs and counter works in browser 🤖 Generated with [Claude Code](https://claude.com/claude-code)

HugoNijhuis added 1 commit 2026-01-09 15:36:26 +00:00

Add README quickstart section ... 46aa4cc502

Provides a complete getting-started guide covering prerequisites,
app creation, HTML host setup, build commands, and running the app.

Closes #1

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

HugoNijhuis commented 2026-01-09 15:37:54 +00:00

Author

Owner

Copy Link

AI Code Review

This is an automated review generated by the code-reviewer agent.

Summary

The README provides a solid quickstart guide, but contains minor issues that would confuse users. The example code uses the correct API and would compile successfully.

Findings

Code Quality

• Code examples are accurate and match the actual API in the codebase
• The quickstart follows a logical progression: prerequisites, app code, HTML host, build, run
• Example demonstrates core Iris concepts: signals, reactive text, button interactions

Potential Bugs

• README.md:12 - The prerequisite 'cp wasm_exec.js ./public/' will fail if public/ doesn't exist. Need 'mkdir -p public' first
• README.md:70 - Build command references './main.go' but quickstart never specifies where to save the app code
• README.md:96 - Server example references 'server.go' without clarifying directory structure

Security Concerns

• No security issues identified

Style Notes

• Consistent with existing documentation style in CLAUDE.md and vision.md
• Good use of code blocks and clear section headers
• Expected output section helps users verify success

Test Coverage

• Not applicable - documentation only

Verdict

Needs Changes

The README needs clarification on file locations and directory structure. Suggest adding:

1. Explicit mkdir -p public before cp command
2. Clear instruction to save app code as main.go
3. Directory structure diagram OR single command setup

These are minor fixes that would prevent user confusion.

## AI Code Review > This is an automated review generated by the code-reviewer agent. ### Summary The README provides a solid quickstart guide, but contains minor issues that would confuse users. The example code uses the correct API and would compile successfully. ### Findings #### Code Quality - Code examples are accurate and match the actual API in the codebase - The quickstart follows a logical progression: prerequisites, app code, HTML host, build, run - Example demonstrates core Iris concepts: signals, reactive text, button interactions #### Potential Bugs - **README.md:12** - The prerequisite 'cp wasm_exec.js ./public/' will fail if public/ doesn't exist. Need 'mkdir -p public' first - **README.md:70** - Build command references './main.go' but quickstart never specifies where to save the app code - **README.md:96** - Server example references 'server.go' without clarifying directory structure #### Security Concerns - No security issues identified #### Style Notes - Consistent with existing documentation style in CLAUDE.md and vision.md - Good use of code blocks and clear section headers - Expected output section helps users verify success #### Test Coverage - Not applicable - documentation only ### Verdict **Needs Changes** The README needs clarification on file locations and directory structure. Suggest adding: 1. Explicit mkdir -p public before cp command 2. Clear instruction to save app code as main.go 3. Directory structure diagram OR single command setup These are minor fixes that would prevent user confusion.

HugoNijhuis added 1 commit 2026-01-09 15:40:28 +00:00

Fix README clarity issues from code review ... 260f46e814

- Add explicit mkdir -p public before wasm_exec.js copy
- Specify to save app code as main.go
- Specify to save server code as server.go

Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>

HugoNijhuis commented 2026-01-09 15:41:45 +00:00

Author

Owner

Copy Link

AI Code Review - Follow-up

This is an automated review generated by the code-reviewer agent.

Summary

All three issues from the previous review have been successfully addressed. The README now provides clear, actionable instructions that users can follow without confusion.

Changes Verified

Previous Issues - All Fixed

1. mkdir -p public before cp command - RESOLVED: Line 16 now includes mkdir -p public before the cp command in the "Project setup" section
2. Clear instruction to save app code as main.go - RESOLVED: Line 22 explicitly states "Save this as main.go:" before the app code
3. Clear instruction about server.go location - RESOLVED: Line 84 explicitly states "Save this as server.go:" before the server code

Code Accuracy

All code examples have been verified against the actual codebase:

• reactive.NewSignal() - Correct API (reactive/signal.go:10)
• ui.TextFromFunction() - Correct API (ui/text.go:14)
• ui.Button() - Correct API signature (ui/button.go:5)
• ui.NewView() - Correct API (ui/view.go:14)
• ui.NewApp() - Correct API (ui/app.go:9)
• host.New() - Correct API (host/server.go:20)

Documentation Quality

• Clear progression: Prerequisites → Setup → App Code → HTML Host → Build → Run → Expected Output
• Proper use of code blocks with language hints
• Consistent formatting and structure
• The quickstart correctly demonstrates Iris's core concepts: signals, reactive rendering, and event handling

Findings

Code Quality

• The README is well-structured and follows a logical flow
• Instructions are specific and actionable
• No ambiguous steps remain

Potential Bugs

• No issues found - all commands and file paths are correct

Security Concerns

• No security issues identified

Style Notes

• Consistent with existing documentation in CLAUDE.md and vision.md
• Clear section headers and proper markdown formatting

Test Coverage

• Not applicable - documentation only

Verdict

LGTM

All previous issues have been addressed. The quickstart guide is now clear, complete, and ready for users to follow without confusion. The README will help users get from zero to a running Iris application successfully.

## AI Code Review - Follow-up > This is an automated review generated by the code-reviewer agent. ### Summary All three issues from the previous review have been successfully addressed. The README now provides clear, actionable instructions that users can follow without confusion. ### Changes Verified #### Previous Issues - All Fixed 1. **mkdir -p public before cp command** - RESOLVED: Line 16 now includes `mkdir -p public` before the `cp` command in the "Project setup" section 2. **Clear instruction to save app code as main.go** - RESOLVED: Line 22 explicitly states "Save this as `main.go`:" before the app code 3. **Clear instruction about server.go location** - RESOLVED: Line 84 explicitly states "Save this as `server.go`:" before the server code #### Code Accuracy All code examples have been verified against the actual codebase: - `reactive.NewSignal()` - Correct API (reactive/signal.go:10) - `ui.TextFromFunction()` - Correct API (ui/text.go:14) - `ui.Button()` - Correct API signature (ui/button.go:5) - `ui.NewView()` - Correct API (ui/view.go:14) - `ui.NewApp()` - Correct API (ui/app.go:9) - `host.New()` - Correct API (host/server.go:20) #### Documentation Quality - Clear progression: Prerequisites → Setup → App Code → HTML Host → Build → Run → Expected Output - Proper use of code blocks with language hints - Consistent formatting and structure - The quickstart correctly demonstrates Iris's core concepts: signals, reactive rendering, and event handling ### Findings #### Code Quality - The README is well-structured and follows a logical flow - Instructions are specific and actionable - No ambiguous steps remain #### Potential Bugs - No issues found - all commands and file paths are correct #### Security Concerns - No security issues identified #### Style Notes - Consistent with existing documentation in CLAUDE.md and vision.md - Clear section headers and proper markdown formatting #### Test Coverage - Not applicable - documentation only ### Verdict **LGTM** All previous issues have been addressed. The quickstart guide is now clear, complete, and ready for users to follow without confusion. The README will help users get from zero to a running Iris application successfully.

HugoNijhuis merged commit 260f46e814 into main 2026-01-09 15:41:51 +00:00

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No Label

Milestone

No items

No Milestone

Projects

Clear projects

No project

Assignees

Clear assignees

HugoNijhuis fluxcd-bot renovate-bot

No Assignees

1 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: flowmade-one/iris#12