Claude Fable 5
0629411966
Initial deliverable of the architecture phase: 16 ADRs (stack, CRDT collaboration, plugin sandbox, import/export, backups, CI/CD), data model, permission model, real-time collaboration and plugin concepts, deployment/operations/security documentation, and the milestone roadmap that the implementation issues are derived from. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
54 lines
2.4 KiB
Markdown
54 lines
2.4 KiB
Markdown
# Dorfteich
|
|
|
|
Dorfteich is an open-source wiki system built around **ponds** (German:
|
|
*Teiche*) — self-contained wiki spaces that people and teams organize freely
|
|
with hierarchical labels, directories, and Obsidian-style page relations.
|
|
Pages are edited in a collaborative WYSIWYG editor with live cursors and
|
|
offline support.
|
|
|
|
- Project site: <https://dorfteich.cloud>
|
|
- Public flagship instance: <https://dorfteich.online>
|
|
- License: [MIT](LICENSE)
|
|
|
|
## Key features
|
|
|
|
- **Real-time collaboration** — multiple people edit the same page
|
|
simultaneously; everyone sees the other participants' cursors and input
|
|
live. Offline edits merge conflict-free on reconnect (CRDT-based).
|
|
- **Ponds** — isolated wiki spaces with their own members, permissions,
|
|
fonts, and page organization. Every registered person gets a personal pond.
|
|
- **Flexible organization** — hierarchical labels, free page ordering,
|
|
`[[wikilinks]]` with backlinks. A classic page tree is possible but never
|
|
enforced.
|
|
- **Fine-grained permissions** — roles (Site Admin, Pond Admin, Editor,
|
|
Reader, Public) can be granted per pond, per label, or per page; the most
|
|
specific setting wins.
|
|
- **Import & export** — Markdown as the primary exchange format, plus
|
|
best-effort structural import from Word/OpenOffice and export to
|
|
Word/OpenOffice/PDF.
|
|
- **Plugins** — sandboxed extensions (custom blocks, styles, page tools)
|
|
installable at runtime without redeploying the instance.
|
|
- **Self-hosting first** — a single `docker compose up` plus a guided
|
|
first-run setup wizard yields a working instance.
|
|
|
|
## Repository layout
|
|
|
|
| Path | Contents |
|
|
| --- | --- |
|
|
| `docs/architecture/` | Architecture documentation: ADRs, data model, permission model, collaboration and plugin concepts, deployment and operations |
|
|
| `apps/` | Application packages (web frontend, API server, collaboration server) — created as implementation proceeds |
|
|
| `packages/` | Shared packages (types, permission logic, plugin SDK) |
|
|
| `deploy/` | Docker Compose stacks and deployment tooling |
|
|
|
|
## Status
|
|
|
|
The project is in the architecture and backlog phase. Implementation stories
|
|
are tracked as issues in this repository. Start reading at
|
|
[`docs/architecture/README.md`](docs/architecture/README.md).
|
|
|
|
## Contributing
|
|
|
|
Code, comments, and documentation are written in English. Write clear code
|
|
that humans can follow easily; when in doubt, prefer readability over
|
|
cleverness. All contributions are accepted under the MIT license.
|