mhoennigandClaude Opus 4.8
63cfd82f07
- prominent oben und in Nutzung/Usage: https://mhoennig.github.io/werkbaum/ - in EN (README.md) und DE (README.de.md) Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
85 lines
3.4 KiB
Markdown
85 lines
3.4 KiB
Markdown
<p>
|
|
<img src="docs/brand/logo.svg" width="72" alt="Werkbaum logo">
|
|
</p>
|
|
|
|
# Werkbaum
|
|
|
|
**English** · [Deutsch](README.de.md)
|
|
|
|
**▶ Try it live: <https://mhoennig.github.io/werkbaum/>** (latest deployed version)
|
|
|
|
A textual, Markdown-like notation for work breakdown structures with
|
|
and/or decomposition — plus a live editor that renders it as a diagram.
|
|
|
|
```
|
|
[~] Werkbaum (XL) https://wiki.example.de/relaunch
|
|
- [~] Document store
|
|
| [x] Text file with copy+paste in the frontend (S)
|
|
- [x] Parser
|
|
- [x] Text input field in the frontend
|
|
| [ ] Backend
|
|
- [~] Display/rendering (XL)
|
|
- [/] H (S) @anna
|
|
- [ ] CMS integration (M)
|
|
| [ ] WordPress
|
|
| [?] Headless CMS
|
|
```
|
|
|
|
`-` = mandatory sub-package (all of, side by side in the diagram) ·
|
|
`|` = alternative (any of, stacked) · `[…]` = status ·
|
|
`(M)` = T-shirt effort · `@name` = responsibility · `%%` = comment.
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
Open the [hosted editor](https://mhoennig.github.io/werkbaum/) — or
|
|
`frontend/index.html` in the browser — edit text on the left, the diagram is
|
|
built live on the right. Toggles: transposed (narrow) layout, show discarded
|
|
elements.
|
|
|
|
## Project documents
|
|
|
|
- `frontend/` — editor · `backend/` — Kotlin/Spring (scaffold to follow, see backend/README.md)
|
|
- `docs/SPEC.md` — normative language definition
|
|
- `docs/DECISIONS.md` — design decisions with rationale
|
|
- `docs/ROADMAP.md` — Mermaid plugin, Taiga integration, Tenzu
|
|
- `docs/TASKS.md` — open tasks (checkboxes)
|
|
- `docs/brand/BRAND.md` — logo, wordmark, usage rules
|
|
- `docs/design/` — design derivation of the brand
|
|
- `CLAUDE.md` — project context for Claude Code
|
|
|
|
> **Note:** The detailed project documentation under `docs/` is maintained in
|
|
> German, the project's source language (see `CLAUDE.md`). This README is
|
|
> available in [English](README.md) and [German](README.de.md).
|
|
|
|
## Deployment
|
|
|
|
The editor is published as a static page on **GitHub Pages** via GitHub
|
|
Actions (workflow: `.github/workflows/pages.yml`). Triggered on every push to
|
|
`main` and manually (`workflow_dispatch`).
|
|
|
|
The workflow assembles a site folder: `frontend/index.html` is placed as
|
|
`index.html` at the root URL, along with the files the editor references
|
|
(`docs/brand/` for the favicon, `LICENSE` for the MIT link in the footer). The
|
|
`../` paths in the editor source are straightened only on the copy — the source
|
|
file stays unchanged. `backend/` and the remaining `docs/` are not published.
|
|
|
|
While assembling the site, the workflow also stamps the version into the footer:
|
|
**major.minor** comes from the `VERSION` file (bumped by an explicit "bump
|
|
commit"), and the **micro** part is the number of commits since that last bump —
|
|
so it grows with every commit and resets to `0` right after a bump
|
|
(`Werkbaum 1.0.0`, `1.0.1`, … then bump `VERSION` to `1.1` → `1.1.0`). Nothing is
|
|
written back to the repo. In the footer the name **Werkbaum** links to the
|
|
repository, while the **version number** links to that exact commit
|
|
(`…/commit/<sha>`). Opened locally, the editor shows the source placeholder
|
|
(`Werkbaum 1.0`).
|
|
|
|
**One-time setup:** In the repo settings under **Pages**, select **Source** =
|
|
"GitHub Actions". The repo must be **public** for this (GitHub Pages via Actions
|
|
is only available for private repos on a paid plan).
|
|
|
|
## License
|
|
|
|
MIT — see [LICENSE](LICENSE). © 2026 Michael Hönnig.
|