Skip to content

Update README.md #146

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Krzysztof-Cieslak merged 3 commits into from
Sep 2, 2026
+9 −3
Merged

Update README.md #146

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
76c77fb
Update README.md
Krzysztof-Cieslak Sep 2, 2026
4c53fe8
fix typo
Krzysztof-Cieslak Sep 2, 2026
0176988
fix typo 2
Krzysztof-Cieslak Sep 2, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,11 @@ changes, and asks the team when the code cannot settle a choice.
> production-ready service. Expect incomplete workflows, operational limits,
> and breaking changes.

![Chopin Overview](docs/images_videos/chopin-tour.mp4)
https://github.com/user-attachments/assets/9ebf0901-6255-47c3-adb3-e905e8f6cab4

> [!TIP]
> We do not provide public Chopin instance for general use. If you want use Chopin on
> your projects you can run it locally or host it on your own.

## What Chopin explores

Expand All @@ -30,15 +34,15 @@ context:
separately from the prose they produced, so a later rewrite cannot silently
change what the team decided.

![Chopin Comments](docs/images_videos/chopin-comments.mp4)
https://github.com/user-attachments/assets/9f429bf0-762d-4d8b-871b-493dbb14c03c

Typing `/research` in a document starts one durable request from the exact brief
and leaves an inline progress card in place. Completed research publishes as an
ordinary child document beneath its parent, with its own document,
Chat, and Decisions. Pending, failed, and cancelled requests never
appear as documents in navigation.

![Chopin Research](docs/images_videos/chopin-research.mp4)
https://github.com/user-attachments/assets/72a85be8-685f-4d60-9937-b3855b46cebe

The Planner can inspect the selected GitHub repository and its pull requests
through bounded, read-only tools, then co-author the document. It cannot write to
Expand Down Expand Up @@ -78,6 +82,8 @@ and tool vocabulary remain optimized for planning.
- One Chopin process may write to a database at a time. Horizontal application
scaling and zero-downtime rolling deployment are not supported.

---

## Run locally

The development path requires:
Expand Down
Loading