Files
werkregie/doc/prs/2026-10-13-PR#55-readme.md
claude-code 0be5eb0530
werkator build succeeded after 00:50
A README that shows what Werkregie is today (#55)
The README describes werkregie as it is today: the dashboard and the master copy of the shared workflow, with a screenshot and a diagram of the connections.

See the PR document under `doc/prs/`.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Reviewed-on: #55
Reviewed-by: ai-reviewer <2+ai-reviewer@noreply.git.javagil.de>
Co-authored-by: claude-code <claude-code@javagil.de>
2026-10-13 08:06:56 +02:00

40 lines
1.5 KiB
Markdown

# PR#55: A README that shows what Werkregie is today
> **WARNING:** This document describes only the change applied in this PR.
> It may already be outdated once the next PR is merged.
> Historic PR documentation is not maintained along with new PRs; treat it as a snapshot.
## Problem
The README says only "An orchestrator for Software Development with Agentic AI".
Werkregie is not an orchestrator yet:
today it is the dashboard and the master copy of the workflow that all Werk repositories follow.
A reader does not see what the dashboard shows, how it connects to the other tools, or where to start.
## Non-Goals
- No change of the dashboard's code or behaviour.
- No new content in `dashboard/README.md`; the README links to it.
- No design of the orchestrator; the plan holds it as an idea.
## Solution
- `README.md`: Werkregie is to become the orchestrator and is so far mainly a dashboard;
it defines the agentic workflow of the Werk family,
a screenshot of the dashboard with demo data,
a Mermaid diagram of the connections to the other tools,
quick start, and the map of the documents.
- `doc/images/dashboard.png`: the screenshot, taken in the mode `server` without the access token,
so that it shows only invented demo data.
- `doc/werkregie.werkbaum`: the node `#ops.readme`.
- Version 0.35.1.
## Additional Changes
- "Werk" is a proper name and gets a capital letter,
also in `doc/werkregie.werkbaum`, `doc/agentic-workflow.md` and `AGENTS.md`.
## Open Questions
None.