Skip to content

Sharpen product narrative and README - #20

Merged
boh5 merged 1 commit into
mainfrom
codex/improve-product-narrative
Aug 19, 2026
Merged

Sharpen product narrative and README#20
boh5 merged 1 commit into
mainfrom
codex/improve-product-narrative

Conversation

@boh5

@boh5 boh5 commented Aug 19, 2026

Copy link
Copy Markdown
Owner

Summary

  • refocus the README on durable Todos, inspectable Agent Sessions, and evidence-backed review
  • move Quick start earlier and group the remaining product story into three supporting sections
  • replace the outdated demo video with three current 2560×1410 screenshots
  • align the concepts guide and package description with the Todo-first workbench model

Why

The previous README made several true capabilities compete at the same level and used a demo video that no longer matched the product. This update gives the product one clear narrative, keeps implementation-level detail in the dedicated docs, and uses current product surfaces as proof.

Validation

  • rendered the README with GitHub-style Markdown at 1280×720 and reviewed the full page
  • parsed the README and verified all 14 local targets
  • verified all three screenshots are 2560×1410 JPEGs
  • ran git diff --check

No product code changed.

Review in cubic

Summary by CodeRabbit

  • Documentation

    • Reorganized and expanded the README with an overview of the AI coding workbench, project workflows, Todos, Sessions, Discussions, Plans, Automations, agent roles, configuration, and review capabilities.
    • Clarified core concepts, including Todo lifecycles, planning, session behavior, and automation workflows.
    • Updated documentation links and project descriptions for improved clarity.
  • Chores

    • Updated the package description to better reflect the product’s focus.

@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Path: .coderabbit.yaml

Review profile: CHILL

Plan: Pro Plus

Run ID: e2e0db00-97ca-4c57-aa94-c323da479984

📥 Commits

Reviewing files that changed from the base of the PR and between b0dc0c2 and caa62d0.

⛔ Files ignored due to path filters (6)
  • docs/assets/archcode-readme-demo-poster.png is excluded by !**/*.png
  • docs/assets/archcode-readme-demo.gif is excluded by !**/*.gif
  • docs/assets/archcode-readme-demo.mp4 is excluded by !**/*.mp4
  • docs/assets/archcode-readme-session-agents.jpg is excluded by !**/*.jpg
  • docs/assets/archcode-readme-todo-detail.jpg is excluded by !**/*.jpg
  • docs/assets/archcode-readme-workbench.jpg is excluded by !**/*.jpg
📒 Files selected for processing (3)
  • README.md
  • docs/concepts.md
  • package.json

Included review availability: Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Self-hosted workbench documentation

Layer / File(s) Summary
Core workbench concepts
docs/concepts.md
Defines Project, Todo, Session, and Automation concepts. Documents Todo lifecycle, planning, session startup, execution races, and Run now behavior.
README workflow and configuration
README.md
Reframes ArchCode as a self-hosted AI coding workbench. Expands Todo, Session, agent role, runtime, model, Automation, and MCP documentation.
Package description metadata
package.json
Updates the package description to identify ArchCode as an open-source, self-hosted AI coding workbench.

Possibly related PRs

  • boh5/archcode#14: Its documentation updates overlap with this PR’s README, concepts, and Skill workflow terminology.

Merge Risk: ⚪ Minimal · up to caa62

This PR updates documentation, product narrative, package description, and screenshots without changing product code; no actionable merge-blocking risk remains beyond normal checks and review.

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and concisely describes the main documentation change: refining the product narrative and README.
Description check ✅ Passed The description includes a clear summary, rationale, validation details, and scope; omitted checklist sections are non-critical for this documentation-only change.
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.

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

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

boh5 commented Aug 19, 2026

Copy link
Copy Markdown
Owner Author

@coderabbitai review

@coderabbitai

coderabbitai Bot commented Aug 19, 2026

Copy link
Copy Markdown
✅ Action performed

Review finished.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

@boh5
boh5 merged commit f64ad76 into main Aug 19, 2026
7 checks passed
@boh5
boh5 deleted the codex/improve-product-narrative branch August 19, 2026 01:45
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